Post Campaign Assignments

post

https://{your-totality-url}.com/api/campaign-assignments

Create a new campaign assignment linking a campaign to an assignable entity. Permission: Create Campaign Assignments

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

applicationDate

string

The date associated with the campaign assignment's application.

assignableId

integer

required

ID of the entity to assign the campaign to.

assignableType

string

required

Type of entity. One of: Loan, Customer, Payment, Communication

campaignUuid

string

required

UUID of the campaign. Must exist and not be soft-deleted.

city

string

City. Falls back to customer residence address if null and customerUuid is linked.

customerUuid

string

UUID of a customer. Must exist and not be soft-deleted. Takes priority over SSN lookup.

string

Email address. Must be valid email format. Falls back to customer email if null.

firstName

string

First name. Falls back to customer first name if null.

lastName

string

Last name. Falls back to customer last name if null.

offerCode

string

Offer code override.

postalCode

string

Postal code. Falls back to customer residence address if null.

salutation

string

Salutation (e.g., Mr., Mrs.). No customer fallback.

ssn

string

Social security number. If no customerUuid provided, used to look up customer.

state

string

State. Falls back to customer residence address if null.

street1

string

Street address line 1. Falls back to customer residence address if null.

street2

string

Street address line 2. Falls back to customer residence address if null.

Headers

string

required

Defaults to application/vnd.totality.v1+json

Content-Type

string

required

Defaults to application/json

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

201Created

401Unauthorized

403Forbidden

422Unprocessable Entity

500Internal Server Error