ONontraport
objects

This will pause Rules, Sequences, and Sequence Subscribers

This will pause Rules, Sequences, and Sequence Subscribers. Either <b>ids</b> or <b>group_id</b> must be given. Every ID in <b>ids</b> must exist; if any does not, the request is rejected and nothing is paused.

post/objects/pause

Request

  • Base URL
    https://api.ontraport.com/1
  • Auth
    none declared

Request body application/x-www-form-urlencoded

objectIDstring required

Object Type ID.

idsstring

Array of Object IDs as comma-delimited list. At least one ID is required OR this field can be substituted with a group_id. If group_id is used, it must be sent in combination with performAll set to 1. This action is disallowed on the live documentation.

startstring

Return results starting at this offset

rangestring

Number of results to return (maximum=50)

sortstring

Field used to sort results

sortDirstring

Sort direction, must be used in conjunction with <b>sort</b> parameter.

conditionstring

See the Criteria examples below

searchstring

Search objects for this string

group_idstring

Group ID as an integer

externsstring

External fields to include in results

listFieldsstring

Array of fields to return in response as comma-delimited list.

Response

Successfully paused Sequence(s)

codeinteger required
dataobject required
account_idinteger required

Changes

No recorded changes to this operation across all 5 revisions of this API.