Update Campaign Assignment

patch

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

Update an existing campaign assignment. Contact/address fields may be changed at any time. The assignable link (assignableId + assignableType) is claim-once: it may be set only while the assignment is unlinked (assignableId null, or 0 on legacy placeholder rows). Re-pointing an already-linked assignment returns a 422 — even with the same value. A null assignableId in the payload is ignored and never unlinks a claimed row. Claiming also auto-fills the assignment's customer link from the claimed record (the loan's borrower, or the customer itself) when no customer is linked yet and no customerUuid is supplied. Permission: Update Campaign Assignments

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

campaignAssignment

string

required

The UUID of the campaign assignment.

Body Params

applicationDate

string

The date associated with the campaign assignment's application.

assignableId

integer | null

Claim an unlinked assignment by linking it to an existing record (e.g. the loan created after a direct-mail recipient applies). Allowed only while the assignment is unlinked (null or legacy 0); the record must exist for the given assignableType. Re-pointing a linked assignment returns 422. Claiming auto-fills customerUuid from the claimed record when no customer is linked yet.

assignableType

string | null

Type of entity being linked. 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

Offer amount associated with this assignment.

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.

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

204No Content

401Unauthorized

403Forbidden

422Unprocessable Entity