ONontraport
objects

This subscribes an Object to a Campaign or Sequence

This will add an Object to a Campaign or Sequence. When adding or removing, either <b>ids</b> or <b>group_id</b> must be given. <b> Note: </b> Campaigns are now called Automations in the Ontraport app.

put/objects/subscribe

Request

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

Request body application/x-www-form-urlencoded

objectIDstring required

Object Type ID.

add_liststring required

Array of Campaign or Sequence IDs as comma-delimited list.

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.

sub_typestring[]

The object ID to subscribe to.

startstring

Return results starting at this offset

rangestring

Number of results to return (maximum=50)

conditionstring

See the Criteria examples below

searchstring

Search objects for this string

externsstring

External fields to include in results

listFieldsstring

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

Response

Successfully added Subscription(s)

codeinteger required
dataobject required
account_idinteger required

Changes

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