API Reference/Audiences

Audiences

For authentication instructions, see API overview.

Endpoints

get/api/v2/audiences

post/api/v2/audiences

get/api/v2/audiences/:id

put/api/v2/audiences/:id

patch/api/v2/audiences/:id

delete/api/v2/audiences/deleted/:id

get

List all audiences

Returns a list of audiences. The audiences are returned in sorted order, with the most recent appearing first.

Query parameters

limitinteger
The number of records to return
pageinteger
The page number
orderstring
The order of the records
sortBystring
The sort of the records
fieldsstring
The filter of the records
pstring
policyFilters
qstring
search query

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/audiences

Response

No response schema

post

Create audiences

Create audiences. You need to pass through any required fields, and you can optionally pass through other fields.

Request body

namestring
categorystring
tagsarray
contactsarray
activeboolean

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl -X POST -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/audiences \
	-d 'name="string"' \
	-d 'category="string"' \
	-d 'tags="array"' \
	-d 'contacts="array"' \
	-d 'active="boolean"'

Response

No response schema

get

Retrieve audiences

Returns a single audience, which you can request by passing through an id in the url.

Path parameters

idstring
ID of the audience

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/audiences/:id

Response

No response schema

put

Update audiences

Path parameters

idstring
ID of the audience

Request body

namestring
categorystring
tagsarray
contactsarray
activeboolean

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl -X PUT \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/audiences/:id \
	-d 'name="string"' \
	-d 'category="string"' \
	-d 'tags="array"' \
	-d 'contacts="array"' \
	-d 'active="boolean"'

Response

No response schema

patch

Update audiences soft

Update audiences soft by setting the values of the parameters passed. Any parameters not set will be unchanged.

Path parameters

idstring
ID of the audience

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/audiences/:id

Response

No response schema

delete

Delete audiences

Path parameters

idstring
ID of the audience

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl -X DELETE \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/audiences/deleted/:id

Response

No response schema