List update audience options
Retrieve the selectable records used to target an update, for one kind of audience at a time. Supports search and pagination, and always returns any…
Retrieve the selectable records used to target an update, for one kind of audience at a time. Supports search and pagination, and always returns any already-selected records so an editor can render a selection it did not page to.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
kind*string
Which set of records to list
Value in
- "documents"
- "certifications"
- "subprocessors"
- "accounts"
- "contacts"
- "templates"
- "parents"
Query Parameters
search?string
Filter the options by title
page?integer
Page to return
Range
1 <= valuelimit?integer
Options per page
Range
1 <= valueselectedIds?string
Comma-separated ids to include regardless of the search and page, so an existing selection stays visible. Repeat the parameter or comma-separate it.
accountIds?string
Comma-separated account ids to scope the options to
Response Body
curl -X GET "https://example.com/api/v1/updates/options/documents?selectedIds=550e8400-e29b-41d4-a716-446655440000%2C7c9e6679-7425-40de-944b-e07fc1f90ae7"Empty
How is this guide?