TRtrueaccord
Account Retractions

Retract Account

Changed on

Account retractions - when an account is retracted the Retain system stops sending all communications to consumer. Please note, that for multi account/record retraction requests, if one or more of the accounts cannot be found in our system (e.g. an incorrect accountNumber or accountNamespace is provided), while other accounts in the request can be found, the validly identified accounts will be retracted and the response will indicate the accounts that were not properly identified in the request. A maximum of 175 accounts/records can be retracted in a single request.

post/inbound/v1/retraction

Request

Request body

accountNumberstring required

Account number of account to retract.

accountNamespacestring required

accountNamespace that the account to retract was originally placed with.

recallReason'PAID' | 'BANKRUPT' | 'DISPUTED' | 'CLOSED' | 'CAMPAIGN_ENDED' required

Reason that the account is being retracted.

Response

successful operation

ClientIdstring required

Client Id

Statusstring required

Response status (SUCCESS)

Messagestring required

Message description

ProcessedRecordsinteger required

Number or records processed

Changes

  • 8a19069a1bb6Revision changes
    • warning

      removed the request property /

    • info

      api tag Account Retractions added

    • info

      api tag Account Placements removed

    • info

      added the new CAMPAIGN_ENDED enum value to the request property /

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response's property default value Inbound process ends without errors was added for the status

    • info

      the response's property default value SUCCESS was added for the status

    • info

      removed the ERROR enum value from the response property for the response status

    • info

      removed the FAILURE enum value from the response property for the response status

    • info

      removed the SUCCESS enum value from the response property for the response status

  • ef0e23c8d084Revision changes
    • info

      the request property / became optional