Fill Envelope

This document contains details for the /api/v1/envelope/fill endpoint, including headers, request body, response, and status codes.

Endpoint

Method	Endpoint
PUT	/api/v1/envelope/fill

Headers

Header	Required	Description
Authorization	Yes	Bearer authorization token
Content-Type	Yes	application/json
Mailbox	Yes	UUID of the mailbox filling the envelope

Request body

Field	Type	Required	Description
uuid	UUID	Yes	UUID of the envelope to fill
data	string	Yes	Envelope XML containing the field values

Request example

PUT /api/v1/envelope/fill
Authorization: Bearer {token}
Content-Type: application/json
Mailbox: 42c95245-30c1-46ef-bd5b-a9a111deec10

{
  "uuid": "89499ba2-287d-404c-87b0-342dc5b01b6a",
  "data": "{envelopeXml}"
}

Envelope XML:

<envelope
  templateUuid="500afafd-711e-471a-a18f-24a89cd4ede3"
  templateVersion="143a2a4b-325e-4c05-a4c1-52f44e21b745"
>
  <documents>
    <document id="ef247568-559a-4ec1-9ecc-6b44c9fb8215">
      <field name="Customer name">ACME Ltd</field>
      <field name="Contract amount">1000.00</field>
    </document>
  </documents>
</envelope>

Use document IDs and field names from the envelope template version.

Response

The endpoint returns 200 OK after updating the field values.

Status codes

Code	Description
200	Fields updated successfully

Related topics

• Working with XML payloads

• Envelope fields

• Error handling and API error codes