Developers
Diamonds

Update a trigger

PATCH/automations/diamond/{diamond_id}/triggers/{trigger_id}

Configures a stage trigger: whether it is enabled, its channel, destination, and template. The destination field must match the selected channel.

HTTP destinations must resolve to a public host; private, loopback, and metadata addresses are rejected.

The change applies to future communications with leads; nothing is sent when the trigger is updated.

Send the trigger's current ETag in the If-Match header to avoid overwriting a newer version.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

diamond_id*string
trigger_id*string

Header Parameters

Idempotency-Key?string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

If-Match?string

Expected revision of the resource, in the same format as the ETag header (W/"<type>:<id>:<revision>"). If the resource has changed since that revision, the request fails with 412 and the revision_mismatch error code. When omitted, the update is applied to the current revision.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/automations/diamond/string/triggers/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "channel": "http",    "created_at": "2019-08-24T14:15:22Z",    "destination": {      "email": "string",      "phone": "string",      "url": "string"    },    "diamond_id": "string",    "enabled": true,    "event_type": "string",    "id": "string",    "object": "trigger",    "revision": "string",    "stage_id": "string",    "updated_at": "2019-08-24T14:15:22Z"  }}

Retrieve a trigger GET

Retrieves a trigger of the Diamond. The destination is masked in the response. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the trigger to avoid overwriting a newer version. Only triggers that belong to the Diamond in the path can be retrieved.

Imports

Next Page