Skip to main content
POST
Batch read memberships

Supported products

Authorizations

Authorization
string
header
required

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

Scopes

crm.segments.read
crm.lists.read

Body

application/json
inputs
object[]
required

An array of record ID inputs. Each element is a string representing a unique record ID to be processed in the batch operation.

Response

successful operation

completedAt
string<date-time>
required

The date and time when the batch operation was completed, in ISO 8601 format.

results
object[]
required

An array of results from the batch operation, each containing record IDs and their associated memberships.

startedAt
string<date-time>
required

The date and time when the batch operation started, in ISO 8601 format.

status
enum<string>
required

The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'.

Available options:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

An object containing additional links related to the batch operation.

requestedAt
string<date-time>

The date and time when the batch operation was requested, in ISO 8601 format.

Last modified on September 9, 2026