Send for Signature

Purpose

To send a contract for signature.

Note: You must add the signature fields for the all respective signers in the contract document before sending for signature. For more information, see Automatic Field Addition.

Endpoints

POST /contracts/{contractApiName}/actions/send-for-signature

Request Details

Request URL

https://contracts.zoho.com/api/v1/contracts/{contractApiName}/actions/send-for-signature

Authorization

Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6

Scope

contracts.contracts.CREATE, contracts.contracts.ALL, ZohoSign.documents.ALL, ZohoSign.account.ALL

Possible Operation Types

contracts.ALL - Full access to contract information
contracts.CREATE - Create contract
documents.ALL - Full access to document information
account.ALL - Full access to Zoho Sign account information

Sample Request

Copiedcurl "https://contracts.zoho.com/api/v1/contracts/msa-with-zenith-dynamics/actions/send-for-signature"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"

Response JSON Keys

actionJSON Array
Represents the list of actions performed on the contract.
stagestring
Represents the current stage of the contract after it has been sent for signature.

Sample Response

Copied{
    "action": [
        {
           "stage": "sign-pending"
        }
    ]
}

Possible Errors

INVALID_URL_PATTERNHTTP 404

Request URL is incorrect. Specify a valid request URL.

Resolution: Provide a valid URL as mentioned in the Request URL section above.

OAUTH_SCOPE_MISMATCHHTTP 401

Unauthorized. The client does not have contracts.contracts.CREATE scope.

Resolution: Create a new client with valid scope. Refer to the Scope section above.

NO_PERMISSIONHTTP 403

Permission denied to create. The user does not have permission to create records.

Resolution: Contact the organization administrator to request the required access.

INTERNAL_ERRORHTTP 500

Internal Server Error.

Resolution: Unexpected and unhandled exception in the server. Try again later or contact the support team for assistance.

INVALID_REQUEST_METHODHTTP 400

The HTTP request method is not a valid one.

Resolution: Specify a valid request method as specified in the Endpoints section above.

AUTHORIZATION_FAILEDHTTP 400

The user does not have sufficient privilege to create module details.

Resolution: Contact the organization administrator to request the required access.

INVALID_SIGNER_MAIL_ADDRESSHTTP 409

Each signer's email address must be unique.

Resolution: Ensure that each signer in the request has a unique email address. Update the payload with distinct email addresses for all signers before resubmitting the request.

INVALID_SIGNING_ORDERHTTP 409

Possible Reasons	Resolution
The signing order number exceeds the maximum possible value.	Ensure that the signing order values assigned to signers do not exceed the total number of signers or the supported range. Provide valid signing order numbers.
The signing order cannot be less than zero.	Verify that all signing order values are non-negative numbers. Negative values are not supported.
The signing order is invalid as the signing order value for some signers is undefined.	Ensure that each signer in the request has a defined and valid signing order. Add missing signing order values before resubmitting the request.