Add Records to a List

curl --request PUT \
  --url https://api.hubapi.com/crm/v3/lists/{listId}/memberships/add \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[
  "<string>"
]'

{
  "recordIdsAdded": [
    "123",
    "456"
  ],
  "recordIdsMissing": [
    "789"
  ]
}

PUT

crm

lists

{listId}

memberships

add

Add Records to a List

curl --request PUT \
  --url https://api.hubapi.com/crm/v3/lists/{listId}/memberships/add \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[
  "<string>"
]'

{
  "recordIdsAdded": [
    "123",
    "456"
  ],
  "recordIdsMissing": [
    "789"
  ]
}

Supported products

Requires one of the following products or higher.

Marketing Hub -Starter

Sales Hub -Free

Service Hub -Free

Content Hub -Starter

Required Scopes

This API requires one of the following scopes:

cms.membership.access_groups.write

crm.lists.read

crm.lists.write

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

listId

string

required

The ILS ID of the MANUAL or SNAPSHOT list.

Body

application/json

The IDs of the records to add to the list.

Response

Successful response

The IDs of the records that were added, removed, and/or found to be missing as a result of the membership update request.

recordIdsMissing

string[]

required

The IDs of the records that were missing (e.g. did not exist in the portal) and so were not added or removed.

recordIdsRemoved

string[]

required

The IDs of the records that were removed from the list.

recordsIdsAdded

string[]

required