SIsignnow

Replace signer: Step 2 - Replace

This endpoint allows API users to assign a new signer to the invite. This is step 2 of 3 to replace a signer in an invite.

post/field_invite

Request

Request body

emailstring required

New signer's email address.

phonestring required

required if "authentication_type": "phone". Phone number requested for identity verification.

role_idstring required

The role id for the new signer. You can find it in the response from GET /document/{{document_id}} request as the role_id parameter in the field_invites array.

passwordstring required

required if "authentication_type": "password". Password requested for identity verification.

remindernumber

In how many days to send a reminder to the signer; 30 days max.

is_replaceboolean required

Boolean: determines whether to use the subject, message, and order of signing specified in the invite to the previous signer. Possible values: "true" - yes, keep the subject, message, and order of signing from the previous signer's invite; "false" - use the subject, message, and the order of signing from this payload.

expiration_daysnumber

In how many days the invite expires; 30 days max.

authentication_typestring

Type of recipient's identity verification. Possible values: "password" or "phone". phone is available on paid plans; on a free trial or without a paid subscription, use password.

decline_by_signaturenumber

Adds the Decline button to the Signature field for the signer. Possible values: 0 - no Decline button, 1- add the Decline button.

Response

Successful response. Returns the ID of the new invite.

idstring required

ID of the new field invite.

Changes

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