List automation SMS blocks

Lists the SMS messages configured inside the account's automations (automation SMS blocks), 20 per request by default and at most 100; page with offset. Requires one of the SMS campaigns permissions (view, manage or send) when granular SMS permissions are enabled. filters[name] matches part of the name; operators are also accepted, e.g. filters[name][starts_with]=Welcome (eq, neq, lt, lte, gt, gte, contains, starts_with, in). Read only. This is the automation SMS block, not an SMS broadcast; broadcasts are served under /sms/broadcasts.

Query Params
integer
≤ 100
Defaults to 20

Number of blocks to return, at most 100. Defaults to 20.

integer
Defaults to 0

Number of blocks to skip. Defaults to 0.

string

Comma-separated block IDs to return; the limit becomes the number of IDs. ids[] may be repeated instead.

string

Keeps the blocks whose name contains this text.

string
enum

Sorts by name.

Allowed:
string

Comma-separated relationships to return alongside the blocks: user, automation, address.

integer
enum

When 1, keeps only the blocks that have a name and belong to an existing automation.

Allowed:
date

Keeps the blocks with automated send activity on or after this day, Y-m-d in America/Chicago.

date

Keeps the blocks with automated send activity on or before this day, Y-m-d in America/Chicago.

filters[automation_ids][]
array of integers

Keeps the blocks of these automations. Repeat the parameter for each automation ID; entries that are not positive integers are ignored, and a comma-separated value is not accepted.

filters[automation_ids][]
Responses

400

A date is not Y-m-d ("Invalid start date format", "Invalid end date format"), or start_date is after end_date ("End date must be after start date"). The body is {"errors": [{"status": 400, "detail": "..."}]}.

403

Forbidden, you are not authorized to access this resource. Check your API Key (also returned without an SMS campaigns permission: "Missing SMS permission: one of campaigns.view, campaigns.manage, campaigns.send")

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json