Skip to main content
POST
Reset a trigger

Authorizations

x-conveyour-token
string
header
required

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

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
trigger_id
string
required

The trigger to reset.

contact_ids
string[]

Array of contact IDs to reset. Use this or contact_id.

contact_id
string

Single contact ID to reset. Use this or contact_ids.

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

Per-contact outcome of a trigger reset. Returned only when at least one contact succeeded — an all-failure run returns an error instead.