Templates

Create an envelope from a template

Changed on

Requires a recipient for every template role. By default auto-sends because the layout was reviewed at save time; pass autoSend: false for a review-first draft. Supports the optional Idempotency-Key header. Repeating the same key and request replays the original 201 response; a key currently in flight returns 409, and reusing a key with a different request returns 422.

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

Request

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

Path parameters

idstring required

Template id

Request body

recipientsobject required
prefillobject
displayNamestring
autoSendboolean
senderOrderinteger

Response

Instantiated envelope

OR

Changes

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property

    • info

      the request property // became optional

    • info

      added subschema #1 subschema #2 to the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body anyOf list for the response status

    • info

      removed the non-success response with the status