Developers
Diamonds

Update a membership stage

PATCH/automations/diamond/{diamond_id}/memberships/{membership_id}

Moves a lead to a later stage of the Diamond.

Leads only move forward: a target stage at or before the current stage is rejected with the state_conflict error code, including a repeat of a transition that already happened. A successful transition sends the communication for the new stage once.

reason is required and is included in the diamond_membership.stage_changed event.

Send the membership'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
membership_id*string

Header Parameters

If-Match?string

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

curl -X PATCH "https://example.com/automations/diamond/string/memberships/string" \  -H "Content-Type: application/json" \  -d '{    "reason": "string",    "target_stage_id": "string"  }'
{  "data": {    "created_at": "2019-08-24T14:15:22Z",    "diamond_id": "string",    "enrollment_id": "string",    "id": "string",    "last_run": {      "at": "2019-08-24T14:15:22Z",      "error": "string",      "status": "failed"    },    "object": "membership",    "pending": {      "next_check_at": "2019-08-24T14:15:22Z",      "queued_events": 0    },    "progress": {      "confirmed_stages": [        "string"      ]    },    "revision": "string",    "stage_id": "string",    "stage_position": 0,    "updated_at": "2019-08-24T14:15:22Z",    "user_id": "string"  }}

Retrieve a membership GET

Retrieves a lead in the Diamond, including its current stage, confirmed progress, and pending scheduled communication. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when moving the membership to another stage to avoid overwriting a newer version. Credentials scoped to specific users can only access memberships of those users.

List processing attempts GET

Returns the processing attempts requested for the membership. All attempts are returned in a single response, without pagination.