TRtrueaccord
Account Updates

Update Account Information

Changed on

Account placements patch. Patch only updates account information for already placed accounts. It can have the same body as the POST request, but the only required fields are: accountNumber, accountNamespace, accountRelationship, and the field to update with the new value. Note that when certain fields are being updated, additional fields become required - for example, updating a phone number requires that the associated SMS consent field also be present in the request. A maximum of 175 accounts/records can be updated in a single request.

patch/inbound/v1/placement

Request

Request body

accountNumberstring required

Account number of the account to update. accountNumber cannot be updated.

accountNamespacestring required

The accountNamespace that this account was originally placed with. accountNamespace cannot be updated.

accountRelationship'SIGNER' required

The accountRelationship that this account was originally placed with. accountRelationship cannot be updated.

accountOpenDatestring

The date the account was originally opened (mm/dd/yyyy)

brandIdstring uuid

An ID representing the brand they want us to represent. This allows us to use different first-party messaging and themes for different brands. We will provide you a set to use.

productType'AUTO' | 'BNPL' | 'CARD' | 'DDA' | 'FITNESS' | 'HEL' | 'HELOC' | 'PRESETTLEMENT' | 'POSTSETTLEMENT' | 'POSTCHARGEOFF' | 'UNSECURED' | 'UTILITY'

Product type of the account.

productDescriptionstring

This identifies the financial product to the consumer in content. Sample sentence: "you have a delinquent balance on your [product description]." If the productDescription is being updated, the productType must also be provided.

dateAssignedstring

The date the account was placed with TrueAccord (mm/dd/yyyy)

expectedRetractionDatestring

An estimated date that the account will be retracted from TrueAccord (based on charge off, or other business rule). This enables additional monitoring and reporting (mm/dd/yyyy)

firstNamestring

Customer First Name

lastNamestring

The last name for this demographic entry

middleNamestring

Customer Last Name

email1string email

Customer email address - primary.

email2string email

Customer email address - additional.

email3string email

Customer email address - additional.

telephone1string

First telephone number for the customer (in a 10-digit format e.g. 8666112731). If the telephone number is being updated, the telephoneSMSConsent, and telephoneVMConsent (if using Voicemail Drops), value must also be provided.

telephoneType1'HOME' | 'WORK' | 'CELL' | 'FAX' | 'BUSINESS'

Type of the first telephone number

telephoneSMSConsent1'YES' | 'NO'

Indicates whether client has consent for SMS communications with this customer, at this number. If the telephoneSMSConsent is being updated, the associated phone number must also be provided.

telephoneVMConsent1'YES' | 'NO'

Indicates whether client has consent for Voicemail Drop communications with this customer, at this number. If the telephoneVMConsent is being updated, the associated phone number must also be provided.

telephone2string

Second telephone number for the customer (in a 10-digit format e.g. 8666112731). If the telephone number is being updated, the telephoneSMSConsent, and telephoneVMConsent (if using Voicemail Drops), value must also be provided.

telephoneType2'HOME' | 'WORK' | 'CELL' | 'FAX' | 'BUSINESS'

Type of the second telephone number

telephoneSMSConsent2'YES' | 'NO'

Indicates whether client has consent for SMS communications with this customer, at this number. If the telephoneSMSConsent is being updated, the associated phone number must also be provided.

telephoneVMConsent2'YES' | 'NO'

Indicates whether client has consent for Voicemail Drop communications with this customer, at this number. If the telephoneVMConsent is being updated, the associated phone number must also be provided.

telephone3string

Third telephone number for the customer (in a 10-digit format e.g. 8666112731). If the telephone number is being updated, the telephoneSMSConsent, and telephoneVMConsent (if using Voicemail Drops), value must also be provided.

telephoneType3'HOME' | 'WORK' | 'CELL' | 'FAX' | 'BUSINESS'

Type of the third telephone number

telephoneSMSConsent3'YES' | 'NO'

Indicates whether client has consent for SMS communications with this customer, at this number. If the telephoneSMSConsent is being updated, the associated phone number must also be provided.

telephoneVMConsent3'YES' | 'NO'

Indicates whether client has consent for Voicemail Drop communications with this customer, at this number. If the telephoneVMConsent is being updated, the associated phone number must also be provided.

addressLine1string

The first line of the address for the customer. Include building number and street name. Separate from ‘addressLine2’, ‘city’, ‘state’ and ‘zipcode’.

addressLine2string

The second line of the address for the customer. Include apartment or suite number. Separate from ‘addressLine1’, ‘city’, ‘state’ and ‘zipcode’.

addressLine3string

The third line of the address for the customer. Separate from ‘addressLine1’, ‘addressLine2’, ‘city’, ‘state’ and ‘zipcode’.

addressType'HOME' | 'WORK'

The type of address transmitted in this record (ex. HOME, WORK)

citystring

The city for the customer.

statestring

The state code for the customer as two-letter abbreviation (e.g. CA, NY, etc.).

zipcodestring

The 5 digit ZIP code for the customer.

totalAmountDueinteger

The total amount that the customer owes on the account (Total Delinquent Amount + Current Amount Due). Amount is in cents.

currentAmountDueinteger

Amount currently due for this billing period (ignoring Delinquent Amount). Amount is in cents.

currentBalanceinteger

The entire balance of the account, regardless of Total Amount Due in this billing period. Amount is in cents.

totalDelinquentAmountinteger

The current delinquent amount on the account. Amount is in cents.

delinquencyDatestring

Date that account became delinquent (mm/dd/yyyy)

cyclesDelinquentinteger

The numbers of cycles that the account is delinquent (number > 0). Used to select Cycle specific email templates.

displayAccountNumberLast4string

Alternate 4 digit display number that will be used in Content if using the last 4 digits of provided Account Number will not be useful/recognizable to customers.

customerNumberstring

Optional number used to group accounts for the identified Customer, if required.

originalCreditorstring

Name of the original creditor for accounts that were previously owned by a different creditor. This field is used to populate content associated with Pre-Settlement and Post-Settlement product types. If this value is being updated, the productType, originalAccountNumber, and currentCreditor are also required.

currentCreditorstring

Name of current creditor. This field is used to populate content associated with Pre-Settlement and Post-Settlement product types. If this value is being updated, the productType, originalAccountNumber, and originalCreditor are also required.

originalAccountNumberstring

Last four digits of the Original Account Number that was assigned by original creditor. This field is used to populate content associated with Pre-Settlement and Post-Settlement product types. If this value is being updated, the productType, originalCreditor, and currentCreditor are also required.

Response

Payload was successfully parsed

ClientIdstring required

Client Id

Statusstring required

Response status (SUCCESS)

Messagestring required

Message description

ProcessedRecordsinteger required

Number or records processed

Changes

  • 22d6fde0b534Revision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

  • 82f94b7996e6Revision changes
    • breaking

      removed the enum value BUSINESS of the request property /

    • info

      added the new WORK enum value to the request property /