POST /public/v1/documents/{id}/recipients/{recipient_id}/reassign

Reassign fields to another signer.

🚧 Before you start

To change a signer in a document, please ensure that:

You can reassign fields to another signer before the original signer has signed the document. You can choose any person except those recipients who have already signed the document.

The endpoint path includes the recipient_id of the original signer and the request body must include the following two parameters:

To retrieve the contact's ID, use the List Contacts endpoint to access a list of all contacts, and then locate the desired contact by searching using the name or email address within the returned list.

Once you execute the call to change the signer, the original signer will be entirely removed from the document. If you wish to retain the original signer as a CC recipient, you can re-add them using the Add CC Recipient endpoint.

🚧 Pre-filled fields

If you change the signer in a document that has already been sent, the signer's pre-filled fields will be completely reset. In the 'Draft' (document.draft) status, pre-filled fields will remain.

Servers

Path parameters

Name Type Required Description
id String Yes

Document UUID

recipient_id String Yes

Recipient UUID

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
id String Yes

Contact uuid.

kind String Yes

Valid values:

  • "contact"
  • "contact_group"

Default value: "contact"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.