Create a membership
/automations/diamond/{diamond_id}/membershipsAdds a user to the Diamond as a lead, starting at the lead stage. A new membership also grants the user access to the Diamond's internal delivery and schedules the communication for the lead stage.
If the user is already a member of this Diamond, the existing membership is returned and no communication is sent again. A user can belong to only one Diamond at a time.
In addition to diamonds.manage_memberships, this operation requires the enrollments.create permission.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Header Parameters
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 POST "https://example.com/automations/diamond/string/memberships" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "user_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" }}List memberships GET
Returns the leads in a Diamond, paginated by cursor. The collection can be filtered by user, stage, and last update time. Credentials scoped to specific users only see the memberships of those users.
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.