Create invitation for participant

Request

Creates a new invitation for a participant.

For manual delivery, the response includes a signing URL that you share with the signer. Allowed while the session is pending or started.

For email or SMS delivery, Docue notifies the signer and no signing URL is returned. The session must already be started.

Manual signing URLs work only after the session has started.

Security

APIKey

Path

session_idstring, (uuid)required

The UUID of the signing session.

Example:0196ae5b-2e9d-729f-aba5-fa4db6f881fd

participant_idstring, (uuid)required

The UUID of the participant.

Example:0196ae5b-2e9d-729f-aba5-fa4db6f88211

Acceptstringrequired

Specify the response format.

Value:"application/json"

Bodyapplication/jsonrequired

typestringrequired

Enum:"email""sms""manual"

Example:"email"

targetstring or null

Email address or E.164 phone number. Unused for manual.

Example:"john.doe@example.org"

messagestring, <= 500 characters

Optional short note shown with the signing link. Not the full email or SMS body — the surrounding template is fixed.

Example:"Please sign by Friday."

curl -i -X POST \
  https://api.embed.docue.com/sign/sessions/0196ae5b-2e9d-729f-aba5-fa4db6f881fd/participants/0196ae5b-2e9d-729f-aba5-fa4db6f88211/invitations \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <YOUR_API Key_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "email",
    "target": "john.doe@example.org",
    "message": "Please sign by Friday."
  }'

Responses

Successfully created the invitation.

Bodyapplication/json

dataobject(SigningSessionParticipantInvitationData)required

Response body. Null when there is nothing to return.

metaobjectrequired

Response

{
  "data": {
    "id": "019f1833-f214-745e-a87c-fdf627b8bc6c",
    "delivery": { … },
    "timeline": { … }
  },
  "meta": {
    "status": { … }
  }
}