Developers
Diamonds18

Create a processing attempt

POST/automations/diamond/{diamond_id}/memberships/{membership_id}/processing-attempts

Requests that the most recent failed communication for the membership be sent again. Failed communications are not retried automatically.

The communication is queued for delivery. If the corresponding stage has already been confirmed, the message is not sent again, preventing duplicates.

A membership with no recorded failure is rejected with 409 state_conflict and details[].reason = no_failed_run.

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

Public ID of the diamond, prefixed with dmd_.

membership_id*string

Public ID of the membership, prefixed with mbr_.

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._:-]. Required by this operation: a missing key returns idempotency_key_required, and a malformed key returns idempotency_key_invalid. Repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/automations/diamond/string/memberships/string/processing-attempts" \  -H "Idempotency-Key: string"
{  "data": {    "created_at": "2019-08-24T14:15:22Z",    "effects": {      "communication_sent": true,      "stage_confirmed": true    },    "error": {},    "event_id": "string",    "id": "string",    "import_id": "string",    "membership_id": "string",    "object": "processing_attempt",    "operation_id": "string",    "requested_by": {      "id": "string",      "kind": "credential"    },    "selection": {      "mode": "initial",      "rows": 0    },    "status": "queued"  }}

List processing attempts GET

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

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`.