Create freeform invite

This endpoint allows API users to create and send a FreeForm invite to sign a document group.

FreeForm invite

A FreeForm invite is an invite with a document that does not contain fields; recipients can add their signature anywhere on the document.

[!NOTE] A FreeForm invite can be sent to the sender's own email address.

Schedule a freeform invite

To send a FreeForm document group invite at a later time, use the Schedule document group invite endpoint with is_freeform_invite: true.

[!NOTE] Custom subject and message require a paid API plan, an API free trial, or a Site License. On a free trial or without a paid subscription, subject can have up to 100 characters and message up to 200 characters.

post/v2/document-groups/{document_group_id}/free-form-invites

Request

Path parameters

ID of the document group.

Request body

messagestring

Email body message for all signers. Requires a paid API plan, an API free trial, or a Site License. Max 200 characters on a free trial or without a paid subscription.

subjectstring

Email subject for all signers. Requires a paid API plan, an API free trial, or a Site License. Max 100 characters on a free trial or without a paid subscription.

redirect_uristring

When the document is signed, the signer is redirected to this URI.

client_timestampinteger required

UNIX timestamp.

Response

The freeform invite was sent.

Changes

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