Add metadata to a document

This endpoint allows API users to add metadata to the selected document. All added metadata will be linked to the document during the invite to sign. Also, if you'd like to use this metadata in any event subscription, you can add upon creating a webhook.

put/document/{document_id}/metadata

Request

Base URL
https://api.signnow.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/signnow/apis/signnow-api/docs/document/:document_id/metadata/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

ID of the document.

Headers

application/json

Request body

keystring

Any type of metadata that should be added to the document. For example,signer_id.

key1string

Any type of metadata that should be added to the document. For example, timestamp.

key2string

Any type of metadata that should be added to the document. For example, document_owner_id.

sourcestring required

The object that uses this metadata. Allowed values: webhook.

Response

The metadata was added to the document.

successboolean

Result of the request. Always true.

Changes

No recorded changes to this operation across all 1 revision of this API.