Skip to main content
POST
Add user to multiple lists

Authorizations

Authorization
string
header
required

Link access token for one Sandbox, Test, or Live authorization.

x-linked-account-id
string
header
required

Selects one of the authorization's linked accounts via the x-linked-account-id header.

Headers

x-linked-account-id
string
required

The linked account to use. The user must have shared it with your app. A missing account returns linked_account_required; an account outside your access returns linked_account_not_granted.

Example:

"conn_example123"

Path Parameters

userId
string
required

Body

application/json
listIds
(integer | string)[]
required

List IDs to add the user to

Required array length: 1 - 5 elements

List ID

Required range: x > 0

Response

Successful response

success
object[]
required
errors
object[]