Send an AutoDoc invitation

Sends an invitation to a recipient (by email or SMS) to start a specific AutoDoc workflow. The recipient receives a link that opens the AutoDoc visitor app and begins the workflow with their identity already attached to the resulting dossier.

Lifecycle. A new invitation is created with status: pending. A background delivery job is enqueued immediately; once the channel provider has accepted the message, status flips to sent and sentAt is populated. Subsequent provider-side events advance status through delivered, opened, and started. If delivery fails permanently the invitation is marked failed and errorMessage is populated.

Link expiration. Invitation links are valid for 30 days from creation. After expiration the link returns an error to the recipient. There is no automatic resend — create a new invitation if needed.

Channel-specific behavior.

  • email: a branded HTML email is sent to recipient. Use a valid email address. Emails are sent from <organization-slug>@auto-doc.ai with your organization name as the display name (e.g. Acme Corp <[email protected]>). Replies route to [email protected].
  • sms: a short message containing the start URL is sent to recipient. Use E.164 (+15551234567) or international format. Loose validation accepts most readable phone formats.

Idempotency. This endpoint is not idempotent — repeated calls create new invitations. If you need de-duplication, send a unique reference and check GET /v1/autodoc/invitations?reference=... before retrying.

Recipient URL shape. The link delivered to the recipient is: https://start.auto-doc.ai/<workflow_token>?invitation_token=<invitation_token> The invitation token in the query string lets the visitor app correlate the resulting dossier with this invitation.

Localization. Set locale to one of the supported language codes to send the email or SMS in that language. Supported codes are returned by GET /v1/autodoc/invitations/locales. Defaults to the organization's default locale or English.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Workflow token (e.g. wf_xxx) to start when the recipient opens the invitation link.

string
enum
required

Delivery channel — "email" or "sms".

Allowed:
string
required

Email address (when channel=email) or phone number in E.164 or international format (when channel=sms). Max 255 characters.

string

Customer-defined identifier (customer number, UUID, order number, etc.) for cross-referencing this invitation back to your own system. Returned verbatim on the invitation entity. Max 255 characters.

string

IETF language tag for the recipient-facing email/SMS content. See GET /v1/autodoc/invitations/locales for supported values. Defaults to the organization default locale, or English if unset.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json