Developers
Diamonds

List stages

GET/automations/diamond/{diamond_id}/stages

Returns all eleven stages of the Diamond, in order. The set of stages is fixed: stages cannot be created or deleted.

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

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/automations/diamond/string/stages"
{  "data": [    {      "id": "lead",      "interval_minutes": 0,      "kind": "lead",      "lesson_id": "string",      "memberships_count": 0,      "object": "stage",      "position": 0,      "trigger_id": "string"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Retrieve a processing attempt GET

Retrieves a processing attempt requested for the membership. Only attempts that belong to the membership in the path can be retrieved; attempts of other memberships return `404 Not Found`.

Update a stage PATCH

Updates the waiting interval of a time-based stage. Only time-based stages accept an interval, and only the supported interval values are accepted. The change applies to future scheduling; communications already scheduled for leads are not affected. Stages share the Diamond's revision: send the Diamond's current `ETag` in the `If-Match` header to avoid overwriting a newer version.