Customize welcome message

This endpoint allows API users to add a welcome message to field invites sent from this application. The welcome message appears when a signer clicks the welcome message button in the signing session.

<img src="/reference-assets/images/Screenshots with attribute explanations/welcome_message.png" alt="Welcome message example">

Notes

  • Each user can have one welcome message. To replace it, reset it with Reset welcome message to default first.
post/v2/signing-session-settings

Request

Headers

application/json

Request body

welcome_messagestring required

Text of the welcome message. Min: 3, Max: 200 characters. Allowed characters: letters A-Z and a-z, digits 0-9, plain brackets (), dot ., dash -, space and comma ,.

Response

The welcome message has been saved. The response body is empty.

Changes

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