Skip to content

Modify Crm List Memberships

POST
/integrations/crm/lists/memberships

Add and remove contacts from ONE CRM list, in a single call.

Both directions are applied in the same request, so this is not two calls pretending to be one - and repeating the same body is idempotent on the provider side. Membership drives who receives the customer’s CRM-side marketing, which is why it is admin-gated.

Authorizations

Parameters

Query Parameters

connection_id
required
string

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Add and/or remove contacts from one CRM list, in a single call.

Both lists are applied in the same request, so this is not two calls pretending to be one - and a retry with the same body is idempotent on the provider side.

object
add_contact_ids
Array<string>
list_id
required

The CRM’s list id.

string
remove_contact_ids
Array<string>

Responses

200

Successful Response

object
data
required

One CRM record, or one provider response.

Open-shaped ON PURPOSE. These bodies carry whatever the provider returned, the field set differs between HubSpot, Salesforce, Pipedrive and SugarCRM, and it grows every time one of them ships something. Pinning it would drop whatever a provider reported that this contract had not caught up on - which on a CRM surface means silently hiding the customer’s own data from them.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string