SIsignnow

Invite to sign via SMS

This endpoint allows users to send a document for signature via SMS. Recipients receive an SMS with a link to the document. It is the same POST /document/{document_id}/invite request as Invite to sign, with signers identified by phone_invite. Different signers of one invite can receive it by SMS or by email.

Learn more about SMS invites.

Notes

  • SMS delivery is available for signers in the to array. Viewers and approvers receive the invite by email.
  • Identify each signer by exactly one of phone_invite, email, or email_group.
  • Use sms_message to customize the SMS text. subject, message, and header in to apply only to signers invited by email.
  • subject and message in the request root are allowed when at least one signer receives the invite by email.
  • phone_invite is + followed by digits, max 14 characters.
  • SMS invites require the CFR and Require login to sign organization settings to be off, and cannot be used with sso_login authentication. See the errors in the 400 response.
  • Custom sms_message and authentication_sms_message require an API free trial, an active API subscription, or a Site License.
post/document/{doc_id_for_sms}/invite

Request

Path parameters

ID of the document. The same document_id as in Invite to sign.

Headers

application/json

Request body

ccstring[]

Email addresses of CC recipients. Each address must be unique.

fromstring required

Sender's email address: you can use only the email address associated with your SignNow account (login email) as from address.

messagestring

Email message for all signers invited by email. Not allowed when all signers are invited by SMS. Requires a paid API plan, an API free trial, or a Site License.

subjectstring

Email subject for all signers invited by email. Not allowed when all signers are invited by SMS. Requires a paid API plan, an API free trial, or a Site License.

cc_messagestring

CC email message for all CC recipients

cc_subjectstring

CC email subject for all CC recipients

complianceobject
redirect_uristring
mail_providerstring
client_timestampinteger
general_expiration_daysinteger

Default expiration_days applied to all recipients in the invite. Min: 1, Max: 180. Default: 30.

Example request

{
  "to": [
    {
      "phone": "+1XXXXXXXXXX",
      "sms_message": "Hi, here is a document for signature from {sender_email}",
      "phone_invite": "+1XXXXXXXXXX",
      "prefill_signature_name": "Jane Doe",
      "authentication_sms_message": "Enter the password {password} to unlock your document.",
      "required_preset_signature_name": "Jane Doe"
    }
  ],
  "viewers": [
    {
      "close_redirect_uri": "https://unique-solutions.com"
    }
  ],
  "approvers": [
    {
      "role": "Approver",
      "email": "approver@email.com",
      "message": "Review and approve the invoice",
      "subject": "Approve the invoice",
      "redirect_uri": "https://www.signnow.com/",
      "redirect_target": "blank"
    }
  ],
  "general_expiration_days": 30
}

Response

Returns success if the request is correct.

statusstring required

The result of the request. Returns success when the SMS invite is sent.

Changes

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