Envelope MetaData

This document contains an overview of envelope metadata, including how to add, update, and delete metadata for envelopes and envelope forms.

It is possible to addarrow-up-right and deletearrow-up-right 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 formsarrow-up-right and will be used in all envelopes created from such forms.

  • Each key name should have 1 - 32 characters length

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

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

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

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

Last updated