What is Metadata?

Metadata allows you to attach extra information to your Signature Requests. Metadata can be added to a Signature Request regardless of its status using the dedicated endpoint.

Use cases

Metadata is generally used by our customers to provide specific context to their business. For example, it can be a customer or member ID, a contract or subscription number, or any other value enabling them to more easily synchronize information in their systems.

How to use metadata?

All endpoints available to manage Metadata can be found in our API Reference.

Rules

• This field must contain JSON data (key / value), with 10 nodes maximum.
• Each node key can have 30 characters maximum.
• Each node value can contain a string (limited to 255 characters), a boolean, an integer or a float.
• HTML content is not allowed.

Valid payload example

"data": {
    "object_type": "Opportunity",
    "object_id": "b5724df2-2773-11ec-9621-0242ac130002",
    "deal_value": 105.5,
    "already_has_an_account": true
}

How to add Metadata to a Signature Request?

Step 1: Initiate a Signature Request

{
    "name": "The name of your Signature Request",
    "delivery_mode": "email",
    "timezone": "Europe/Paris",
}

Once the Signature Request has been initiated, keep the Signature Request id, it will be useful to add Metadata.

Note that this step is optional, you can use the Signature Request idfrom a Signature Request previously created regardless of its current status.

Step 2: Add Metadata to the Signature Request

"data": {
    "object_type": "Opportunity",
    "object_id": "b5724df2-2773-11ec-9621-0242ac130002",
    "deal_value": 105.5,
    "already_has_an_account": true
}

How to retrieve Metadata to a Signature Request?

Retrieving Metadata is straightforward, all you need to have is your Signature Request id, then you can use this endpoint GET /signature_requests/{signatureRequestId}/metadata.