Promo Programs Type

Create promo program type

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

Request Body schema: application/json
required
promoType
required
string

The promotional program type.

Value: "sameAsCash"
externalId
string

A lender's unique identifier for a specific promotional program type.

status
string
Default: "draft"

The promo type status. A new type is normally created in the draft status. When you are ready to offer the promotional program type on loans, update the status to active.

If the status changes to deprecated, the promotional program cannot be used on new loans. Loans in-flight will continue to be eligible to the deprecated promotional program.

Enum: "draft" "active" "deprecated"
displayName
required
string

The promotional program name as it is shown to borrowers.

description
string <= 10000 characters

A legal description of the promotional program as it should be communicated and shown to borrowers. If the description is provided, borrowers will see the description in the Borrower Portal.

metaData
object or null

Store any type of key/value pairs in the form of a JSON dictionary.

Responses
200

Success

post/companies/{companyId}/promo-program-types
Request samples
application/json
{
  • "promoType": "sameAsCash",
  • "externalId": "string",
  • "status": "draft",
  • "displayName": "string",
  • "description": "string",
  • "metaData": { }
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get promo program types

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

Responses
200

Success

get/companies/{companyId}/promo-program-types
Response samples
application/json
{
  • "count": 0,
  • "data": [
    ]
}

Get promo program type by ID

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

promoProgramTypeId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The promotional program type identifier.

Responses
200

Success

get/companies/{companyId}/promo-program-types/{promoProgramTypeId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update promo program type

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

promoProgramTypeId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The promotional program type identifier.

Request Body schema: application/json
required
externalId
string

A lender's unique identifier for a specific promotional program type.

status
string
Default: "draft"

The promo type status. A new type is normally created in the draft status. When you are ready to offer the promotional program type on loans, update the status to active.

If the status changes to deprecated, the promotional program cannot be used on new loans. Loans in-flight will continue to be eligible to the deprecated promotional program.

Enum: "draft" "active" "deprecated"
displayName
string

The promotional program name as it is shown to borrowers.

description
string <= 10000 characters

A legal description of the promotional program as it should be communicated and shown to borrowers. If the description is provided, borrowers will see the description in the Borrower Portal.

metaData
object or null

Store any type of key/value pairs in the form of a JSON dictionary.

Responses
200

Success

put/companies/{companyId}/promo-program-types/{promoProgramTypeId}
Request samples
application/json
{
  • "externalId": "string",
  • "status": "draft",
  • "displayName": "string",
  • "description": "string",
  • "metaData": { }
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Cancel promo program type

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

promoProgramTypeId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The promotional program type identifier.

Responses
204

Success no content

delete/companies/{companyId}/promo-program-types/{promoProgramTypeId}

Request sandbox access