/api/campaign-assignments/bulk

post

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

Create up to 1,000 campaign assignments under a single campaign in one request. Each record supports the same fields as POST /api/campaign-assignments, except campaignUuid, which is supplied once at the top level and applies to every record.

Records are processed independently: valid records are created even when other records in the same batch fail validation. The response returns a per-record outcome for every submitted record, in submission order, and always uses status 200 when the batch is processed — inspect each record's success flag rather than relying on the status code.

The entire request is rejected with a 422, before any record is created, when the campaignUuid is missing, does not exist or is soft-deleted; when the assignments array is missing or empty; or when it contains more than 1,000 records.

Permission: Create Campaign Assignments

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

assignments

array of objects

required

length between 1 and 1000

The assignment records to create. Must contain at least one and no more than 1,000 records.

assignments*

applicationDate

string

The date associated with the campaign assignment's application.

assignableId

integer | null

ID of the entity to assign the campaign to. Optional: omit (or send null) to create an unlinked prospect assignment — e.g. a direct-mail recipient with no loan yet — which can be linked later by PATCHing assignableId once. When provided, the record must exist for the given assignableType or a 422 is returned.

assignableType

string | null

Type of entity. One of: Loan, Customer, Payment, Communication. Required when assignableId is provided.

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.

offerAmount

integer | null

-2147483648 to 2147483647

Offer amount associated with this assignment. Must be between -2147483648 and 2147483647.

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.

campaignUuid

uuid

required

UUID of the campaign every record in this batch is assigned to. Must exist and not be soft-deleted.

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

200The batch was processed. Inspect each record's success flag: a 200 does not mean every record was created.

401Unauthorized

403Forbidden

422Unprocessable Entity