Skip to main content
PUT
Update a trigger

Authorizations

x-conveyour-token
string
header
required

Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.

Path Parameters

id
string
required

The id identifier.

Query Parameters

teams[]
string[]

Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.

Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.

Body

application/json
campaign_id
string

Campaign context (used for scoping the update lookup).

draft
boolean

Set to true or false to change the trigger's draft state.

paused
boolean

Set to true to pause the trigger, false to resume.

...
string

Any other top-level trigger fields to update (e.g. lesson_id, delay, name).

Response

Success.

The common response envelope shared by all ConveYour endpoints.

status
enum<string>

ok on success, failed on error.

Available options:
ok,
failed
message
string

Human-readable description of the result.

data
object

An automation trigger. Each trigger type carries additional type-specific keys beyond the base fields listed here.