Sequences API Reference
API Reference/Sequences

Sequences

For authentication instructions, see API overview.

Endpoints

get/api/v2/sequences
post/api/v2/sequences
get/api/v2/sequences/:id
put/api/v2/sequences/:id
patch/api/v2/sequences/:id
delete/api/v2/sequences/deleted/:id
post/api/v2/sequences/activity
get

List all sequences

Returns a list of sequences. The sequences 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/sequences

Response

No response schema
post

Create sequences

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

Request body

  • namestring
  • codestring
  • scheduleobject
  • prioritystring
  • ownerobject
  • typestring
  • emailFromobject
  • maxContactsinteger
  • tagsarray
  • statusstring
  • stepsarray
  • contactsarray
  • templatestring
  • startDatestring
  • endDatestring
  • deletedstring

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/sequences \
	-d 'name="string"' \
	-d 'code="string"' \
	-d 'schedule="object"' \
	-d 'priority="string"' \
	-d 'owner="object"' \
	-d 'type="string"' \
	-d 'emailFrom="object"' \
	-d 'maxContacts="integer"' \
	-d 'tags="array"' \
	-d 'status="string"' \
	-d 'steps="array"' \
	-d 'contacts="array"' \
	-d 'template="string"' \
	-d 'startDate="string"' \
	-d 'endDate="string"' \
	-d 'deleted="string"'

Response

No response schema
get

Retrieve sequences

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

Path parameters

  • idstring

    ID of the sequence

Request

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

Response

No response schema
put

Update sequences

Path parameters

  • idstring

    ID of the sequence

Request body

  • namestring
  • codestring
  • scheduleobject
  • prioritystring
  • ownerobject
  • typestring
  • emailFromobject
  • maxContactsinteger
  • tagsarray
  • statusstring
  • stepsarray
  • contactsarray
  • templatestring
  • startDatestring
  • endDatestring
  • deletedstring

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/sequences/:id \
	-d 'name="string"' \
	-d 'code="string"' \
	-d 'schedule="object"' \
	-d 'priority="string"' \
	-d 'owner="object"' \
	-d 'type="string"' \
	-d 'emailFrom="object"' \
	-d 'maxContacts="integer"' \
	-d 'tags="array"' \
	-d 'status="string"' \
	-d 'steps="array"' \
	-d 'contacts="array"' \
	-d 'template="string"' \
	-d 'startDate="string"' \
	-d 'endDate="string"' \
	-d 'deleted="string"'

Response

No response schema
patch

Update sequences soft

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

Path parameters

  • idstring

    ID of the sequence

Request

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

Response

No response schema
delete

Delete sequences

Path parameters

  • idstring

    ID of the sequence

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/sequences/deleted/:id

Response

No response schema
post

Create sequences activity

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

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/sequences/activity

Response

No response schema