Envelope Metadata (API)

This document explains how API users can add, update, and delete envelope metadata, including key/value limits and delete request rules.

It is possible to add and delete metadata from envelopes. It is only available for API users and this data will also only be visible to API users. Metadata can also be added to envelope forms and will be used in all envelopes created from such forms.

1. Each key name should have 1 - 32 characters length

2. Each key value should have 0 - 128 characters length and can be a string, boolean or NULL

3. To delete certain metadata key-value pairs in the envelope, add them to the DELETE request as query parameters (&key=additionalProp1?key=additionalProp2)

4. To delete all metadata key-value pairs in the envelope, send the DELETE request without query parameters

5. To update or delete metadata in the form, use regular form update endpoint to overwrite the metadata