Add Accounts to List

Adds Accounts to the specified Account List.

NOTE: Only accounts which have previously been imported to Terminus Data Studio can be added to an Account List. Accounts cannot be created via this API.

Request
Security:
bearerAuth
path Parameters
listId
required
string

The Id of the Account List to add Accounts to.

Request Body schema: application/json
Array of objects (v2AccountRequest)

An array of Accounts. Limited to a max of 1000 accounts per request.

Responses
200

A successful response.

400

Returned when bad request is received.

401

Returned when a request is made without a valid API key

403

Returned when the given user does not have permissions on the requested resource

404

Returned when the given resource is not found

429

Returned when the given user has reached their API rate limits.

500

Returned when there is an unrecoverable error in the API. If you continue to receive this error, please contact support and include your terminus-request-id.

503

Returned when the service is currently unavailable.

post/accountLists/v2/accountLists/{listId}/accounts/add
Request samples
    1 more
    Java
application/json
{
  • "accounts": [
    • {
      • "id": "string",
      • "crmOrgId": "string",
      • "crmType": "string"
      }
    ]
}
Response samples
    3 more
    429
    500
    503
application/json
{
  • "listId": "string",
  • "successfulAccounts": [
    • {
      • "id": "string",
      • "name": "string",
      • "crmOrgId": "string",
      • "crmType": "string"
      }
    ],
  • "accountsNotFound": [
    • "string"
    ],
  • "addedAccounts": 0,
  • "duplicateAccounts": 0
}