--- title: "Update Account Information" method: PATCH path: "/inbound/v1/placement" tags: ["Account Updates"] --- # Update Account Information `PATCH /inbound/v1/placement` ## Request - Base URL: `https://virtserver.swaggerhub.com/felipediazc/integration/0.0.2` - URL: `https://virtserver.swaggerhub.com/felipediazc/integration/0.0.2/inbound/v1/placement` - Auth: API key in header `X-API-KEY` - TypeScript: (a function with typed inputs; its response is checked against the schema) 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. ## Request body - PlacementInformationPatch[] - `accountNumber` string, required: Account number of the account to update. accountNumber cannot be updated. - `accountNamespace` string, 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. - `accountOpenDate` string: The date the account was originally opened (mm/dd/yyyy) - `brandId` string, 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. - `productDescription` string: 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. - `dateAssigned` string: The date the account was placed with TrueAccord (mm/dd/yyyy) - `expectedRetractionDate` string: 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) - `firstName` string: Customer First Name - `lastName` string: The last name for this demographic entry - `middleName` string: Customer Last Name - `email1` string, email: Customer email address - primary. - `email2` string, email: Customer email address - additional. - `email3` string, email: Customer email address - additional. - `telephone1` string: 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. - `telephone2` string: 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. - `telephone3` string: 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. - `addressLine1` string: The first line of the address for the customer. Include building number and street name. Separate from ‘addressLine2’, ‘city’, ‘state’ and ‘zipcode’. - `addressLine2` string: The second line of the address for the customer. Include apartment or suite number. Separate from ‘addressLine1’, ‘city’, ‘state’ and ‘zipcode’. - `addressLine3` string: 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) - `city` string: The city for the customer. - `state` string: The state code for the customer as two-letter abbreviation (e.g. CA, NY, etc.). - `zipcode` string: The 5 digit ZIP code for the customer. - `totalAmountDue` integer: The total amount that the customer owes on the account (Total Delinquent Amount + Current Amount Due). Amount is in cents. - `currentAmountDue` integer: Amount currently due for this billing period (ignoring Delinquent Amount). Amount is in cents. - `currentBalance` integer: The entire balance of the account, regardless of Total Amount Due in this billing period. Amount is in cents. - `totalDelinquentAmount` integer: The current delinquent amount on the account. Amount is in cents. - `delinquencyDate` string: Date that account became delinquent (mm/dd/yyyy) - `cyclesDelinquent` integer: The numbers of cycles that the account is delinquent (number > 0). Used to select Cycle specific email templates. - `displayAccountNumberLast4` string: 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. - `customerNumber` string: Optional number used to group accounts for the identified Customer, if required. - `originalCreditor` string: 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. - `currentCreditor` string: 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. - `originalAccountNumber` string: 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 `200` Payload was successfully parsed - InboundAPIResponse200 - `ClientId` string, required: Client Id - `Status` string, required: Response status (SUCCESS) - `Message` string, required: Message description - `ProcessedRecords` integer, required: Number or records processed ## Other responses - `400`: Bad request - refer to message and/or FailedRecords for additional information. Requests can fail for a variety of reasons, e.g. invalid JSON formatting, invalid or required fields not being present. - `500`: Internal server error - an error occurred while processing the request. ## Changes - **2023-08-01** `22d6fde0b534`: 3 info - added the new optional request property `items/telephoneVMConsent1` - added the new optional request property `items/telephoneVMConsent2` - added the new optional request property `items/telephoneVMConsent3` - **2023-06-26** `82f94b7996e6`: 1 breaking, 1 info - removed the enum value `BUSINESS` of the request property `items/addressType` - added the new `WORK` enum value to the request property `items/addressType` - **2023-05-16** `8a19069a1bb6`: 1 breaking, 11 warning, 27 info - removed the enum value `COSIGNER` of the request property `items/accountRelationship` - removed the request property `items/brandID` - removed the request property `items/lastPaymentAmount` - removed the request property `items/lastPaymentDate` - …35 more - **2022-06-06** `2e947a46e3e5`: 4 info - added the new optional request property `items/productDescription` - added the new `BNPL` enum value to the request property `items/productType` - added the new `FITNESS` enum value to the request property `items/productType` - added the new `UTILITY` enum value to the request property `items/productType` - **2022-06-03** `53402ea03c77`: 6 info - added the new optional request property `items/telephoneSMSConsent1` - added the new optional request property `items/telephoneSMSConsent2` - added the new optional request property `items/telephoneSMSConsent3` - added the new optional request property `items/telephoneType1` - …2 more [Operation history](https://skmtc.dev/trueaccord/apis/trueaccord-retain-inbound-api/changes/inbound/v1/placement/patch.md) --- [API](https://skmtc.dev/trueaccord/apis/trueaccord-retain-inbound-api.md) - [All operations](https://skmtc.dev/trueaccord/apis/trueaccord-retain-inbound-api/llms.txt) - [OpenAPI document](https://skmtc.dev/trueaccord/apis/trueaccord-retain-inbound-api/revisions/22d6fde0b534?raw)