ATatlaswork
envelopes

Send an envelope

Changed on

Transitions the envelope to in_progress in one transaction: validates the stored document (presence + pdf|docx content type; upload-mode envelopes get their contentHash/sizeBytes computed from the stored bytes), requires ≥1 participant, appends envelope.sent and participant.link_issued for the first signer (version bumps twice). Emits the atlas/envelope.sent notification event (identifiers only). Supports the Idempotency-Key header: a replayed completed key returns the envelope's current graph with the original status code and Idempotency-Replayed: true (never re-executing); an in-flight duplicate is rejected 409; reusing a key with a different request is rejected 422.

post/api/v1/envelopes/{id}/send

Request

  • Base URL
    https://api.atlaswork.ai
  • URL
    https://api.atlaswork.ai/api/v1/envelopes/{id}/send
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

idstring required

Envelope id

Request body

expectedVersioninteger

Response

The sent envelope graph (status in_progress)

Changes

  • d3b4f91b9bb2Revision changes
    • warning

      added the new skipped enum value to the / response property for the response status

    • info

      removed the non-success response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status