Sign in
latestOpenAPI 3.0.02026-08-10416661.5 MB

e96b3e58b041

Triggers

Create trigger

REQUIRED SCOPES <code>['triggers:write']</code><br>Create trigger

post/triggers

Request body

namestring

Name

messagestring

Message

is_track_conversionboolean

Keep track of conversions?

conversion_idinteger

The ID of the Conversation

number_idinteger

Number ID

Example request

{
  "send_from": {
    "type": "send_from_rcs_sender|send_from_number|send_from_smart_inbox",
    "options": {
      "team_id": 1,
      "number_id": 1,
      "smart_option": "default"
    }
  }
}

Response

OK

idinteger

ID of the trigger

organization_idinteger

ID of the organization

integration_idstring

ID of the integration

owner_idinteger

ID of the owner

organization_number_idinteger

ID of the organization number

number_idinteger

ID of the number

team_idinteger

ID of the team

is_activeboolean

Indicates if the trigger is active

namestring

Name of the trigger

typestring

Type of the trigger

service_propertystring

Service property of the trigger

owner_propertystring

Owner property of the trigger

messagestring

Message of the trigger

media_urlstring[]

Media URL of the trigger

last_received_datestring date-time

Last received date of the trigger

disabled_atstring date-time

Disabled date of the trigger

created_atstring date-time

Creation date of the trigger

updated_atstring date-time

Last update date of the trigger

integration_namestring

Name of the integration

tag_idsinteger[]

IDs of the tags

integrationobject

Integration details

webhookobject

Webhook details

numberobject

Number details

teamobject

Team details

tagsobject[]

Tags details

statisticsobject[]

Statistics details

short_urlsobject[]

Short URLs details

ownerobject

Owner details

analyticsobject

Analytics details

is_track_conversionboolean

Indicates if the trigger tracks conversion

conversion_idinteger

ID of the conversion

is_rvmboolean

Indicates if the trigger is RVM

send_forminteger[]

Send frim information

all_statisticsinteger[]

Statistics