Skip to main content
PATCH
Partially update Engage list

Authorizations

Authorization
string
header
required

Partner OAuth2 flows for integration API access tokens. Claude MCP custom connectors use authorization code with PKCE S256.

FlowAuthorization Code
Authorization URL
/api/v1/oauth/authorize
Token URL
/api/v1/oauth/token
FlowClient Credentials
Token URL
/api/v1/oauth/token
Scopes1
engage.lists:write
Create and update engagement lists and members.

Headers

X-Organization-Id
string<uuid>

Active organization UUID. Required for authenticated requests when the principal has access to multiple organizations.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Path Parameters

listId
string<uuid>
required
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Query Parameters

organizationId
string<uuid>

Read-only convenience alias for X-Organization-Id. Legacy subscriberId query param is also accepted.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Body

application/json
name
string
Required string length: 1 - 300
description
string | null
ownerUserId
string<uuid>
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
accountIds
string<uuid>[]
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
accountTypes
string[]
accountStatuses
string[]
accountRelationshipStatuses
string[]
accountTags
string[]
accountTagCategories
string[]

Account-level filter: tag category keys from the organization account_types.tag_category_map.

engagementStatuses
string[]

Contact-level filter on relationship-map contact_status (e.g. Contacted, Not Contacted, Actively Engaged, Ghosting). Always AND’d with account filters.

requireFirstDegreeConnection
boolean

When true, only contacts who are LinkedIn 1st-degree connections of the list owner (from cached linkedin_relations) are included. Always AND’d with other filters.

accountOwnerIds
string<uuid>[]
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
sourcePersona
string[]
dynamicFilterOperator
enum<string> | null
Available options:
and,
or

Response

Updated list.

list
object
required