Add user to multiple lists

Add a single user to multiple lists in one call

Permission Required: lists:write

POST /v2/access/users/:userId/lists

Add user to multiple lists

cURL

curl --request POST \
  --url https://api.ofauth.com/v2/access/users/:userId/lists \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>' \
  --data '
{
  "listIds": [
    1
  ]
}
'

200

{
  "success": [
    {
      "listId": 123,
      "success": true
    }
  ],
  "errors": [
    {
      "listId": 123,
      "error": "<string>"
    }
  ]
}

Authorizations

apiKey · string · header · required

Your OFAuth API key for authenticating requests.

x-connection-id · string · header · required

Requires a connection via the x-connection-id header.

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

200

application/json

Successful response

success · object[] · required

Show child attributes

errors · object[]

Show child attributes