Interactions

Send the next step of an interaction

Send the next step from our side of an existing interaction, validated against its current state. An interaction on a mailbox the caller cannot send from is answered as not found.

post/interactions/{id}/steps

Request

  • Base URL
    https://api.primitive.dev/v1
  • URL
    https://api.primitive.dev/v1/interactions/{id}/steps
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

The interaction id (interaction_id in the send response).

Headers

Idempotency-Keystring

Optional client-supplied idempotency key. Retrying a request with the same key returns the original result instead of performing the action a second time; if omitted the server derives one from the canonical payload hash. Safe to retry network failures without duplicating side effects.

Request body

stepstring required
payloadunknown
expires_atstring date-time nullable
subjectstring
body_textstring

Response

Send the next step of an interaction

successtrue required

Changes

No operation changes recorded.