Skip to main content

Start with the APILists

Lists

Static audiences. The same path as the Lists screen.

GET/api/v1/lists

Use Contacts scopes. Smart-list membership writes fail closed.

HTTPPathScope
GET/api/v1/listsrest.crm.contacts.read
GET/api/v1/lists/{id}rest.crm.contacts.read
GET/api/v1/lists/{id}/contactsrest.crm.contacts.read
POST/api/v1/listsrest.crm.contacts.write
POST/api/v1/lists/{id}/contactsrest.crm.contacts.write
DELETE/api/v1/lists/{id}/contacts/{contact_id}rest.crm.contacts.write

Fields

FieldTypeNotes
namestringRequired on create.
typestringstatic on MVP.
contact_idUUIDMember.