Send a quote to one or more recipients for electronic signature. The quote will be sent through the configured e-signature provider (e.g., DocuSign) and recipients will receive an email with instructions to sign. This operation is asynchronous and returns a job ID to track the progress.
", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "quoteId", "type": "string", "example": "0Q0RL000002cxsL0AQ", "description": "The unique identifier of the quote to send for e-signature
" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "Document and recipient information for e-signature request
", "customType": "SendForSignatureRequest", "schema": [ { "name": "templateId", "kind": "optional", "type": "stringThe ID of the e-signature template to use. If null, the default template will be used.
", "example": "1581de4a-3613-413c-8586-792bde70b307", "format": "uuid" }, { "name": "recipients", "kind": "required", "type": "array", "description": "List of recipients who will receive the quote for signature or review", "modelRef": "#/components/schemas/Recipient", "customType": "Recipient[]", "schema": [ { "name": "tag", "kind": "required", "type": "string", "description": "Tag to categorize the recipient", "example": "Customer" }, { "name": "name", "kind": "required", "type": "string", "description": "Full name of the recipient", "example": "Jack Chen" }, { "name": "email", "kind": "required", "type": "stringAPI key for authentication. Format: Bearer {your-api-key}
", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "e-Signature job created successfully
", "jsonExample": "", "isExpanded": true, "subExamples": [ { "label": "GENERATED", "code": "// e-Signature job created successfully\n{\n \"jobId\": \"2125b6ba-0aec-4a8d-8ca1-da0ec6bfedd4\"\n}" }, { "label": "Success Response", "code": "{\n \"jobId\": \"2125b6ba-0aec-4a8d-8ca1-da0ec6bfedd4\"\n}" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "SendForSignatureResponse", "schema": [ { "name": "jobId", "kind": "optional", "type": "stringUnique identifier for the e-signature job
", "example": "2125b6ba-0aec-4a8d-8ca1-da0ec6bfedd4", "format": "uuid" } ], "modelRef": "#/components/schemas/SendForSignatureResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request - Invalid quote or recipient information
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "error", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "Error code", "example": "INVALID_DOCUMENT" }, { "name": "message", "kind": "optional", "type": "string", "description": "Error message", "example": "Document not found or cannot be sent for signature" }, { "name": "details", "kind": "optional", "type": "array", "description": "Additional error details", "example": "[\"Document must be in Draft or Pending status to send for signature\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized - Invalid or missing API key
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "error", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "Error code", "example": "INVALID_DOCUMENT" }, { "name": "message", "kind": "optional", "type": "string", "description": "Error message", "example": "Document not found or cannot be sent for signature" }, { "name": "details", "kind": "optional", "type": "array", "description": "Additional error details", "example": "[\"Document must be in Draft or Pending status to send for signature\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "404", "description": "Not Found - Quote does not exist
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "error", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "Error code", "example": "INVALID_DOCUMENT" }, { "name": "message", "kind": "optional", "type": "string", "description": "Error message", "example": "Document not found or cannot be sent for signature" }, { "name": "details", "kind": "optional", "type": "array", "description": "Additional error details", "example": "[\"Document must be in Draft or Pending status to send for signature\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "plA9g7FvIXBCrc16Sfphh", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.nue.io/v1/cpq/quotes/{quoteId}:eSign \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data-raw '{\n \"recipients\": [\n {\n \"tag\": \"Customer\",\n \"name\": \"Jack Chen\",\n \"email\": \"jack.chen@company.com\",\n \"role\": \"Customer\",\n \"action\": \"Needs to Sign\"\n }\n ],\n \"email\": {\n \"subject\": \"Order Form for your e-Signature (Sent by API)\",\n \"message\": \"This is a request for your electronic signature, please review your order form and electronically sign by following the link below.\"\n }\n }'" }, { "id": "dto_qqfz3RfUzl8aqxrF6", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"recipients\": [\n {\n \"tag\": \"Customer\",\n \"name\": \"Jack Chen\",\n \"email\": \"jack.chen@company.com\",\n \"role\": \"Customer\",\n \"action\": \"Needs to Sign\"\n }\n ],\n \"email\": {\n \"subject\": \"Order Form for your e-Signature (Sent by API)\",\n \"message\": \"This is a request for your electronic signature, please review your order form and electronically sign by following the link below.\"\n }\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/v1/cpq/quotes/{quoteId}:eSign\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "fweVLjLXmhUD0E2xIOl9q", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/v1/cpq/quotes/{quoteId}:eSign\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"recipients\": [\n {\n \"tag\": \"Customer\",\n \"name\": \"Jack Chen\",\n \"email\": \"jack.chen@company.com\",\n \"role\": \"Customer\",\n \"action\": \"Needs to Sign\"\n }\n ],\n \"email\": {\n \"subject\": \"Order Form for your e-Signature (Sent by API)\",\n \"message\": \"This is a request for your electronic signature, please review your order form and electronically sign by following the link below.\"\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "eho1CAFCE7fD2OuowmHHm", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/v1/cpq/quotes/{quoteId}:eSign\"\n\npayload = json.dumps({\n \"recipients\": [\n {\n \"tag\": \"Customer\",\n \"name\": \"Jack Chen\",\n \"email\": \"jack.chen@company.com\",\n \"role\": \"Customer\",\n \"action\": \"Needs to Sign\"\n }\n ],\n \"email\": {\n \"subject\": \"Order Form for your e-Signature (Sent by API)\",\n \"message\": \"This is a request for your electronic signature, please review your order form and electronically sign by following the link below.\"\n }\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "plA9g7FvIXBCrc16Sfphh" }, "results": { "languages": [ { "id": "WhS5RhsmKJBb8MkNruWkx", "language": "200", "code": "// e-Signature job created successfully\n{\n \"jobId\": \"2125b6ba-0aec-4a8d-8ca1-da0ec6bfedd4\"\n}", "subExamples": [ { "label": "GENERATED", "code": "// e-Signature job created successfully\n{\n \"jobId\": \"2125b6ba-0aec-4a8d-8ca1-da0ec6bfedd4\"\n}" }, { "label": "Success Response", "code": "{\n \"jobId\": \"2125b6ba-0aec-4a8d-8ca1-da0ec6bfedd4\"\n}" } ] }, { "id": "QgIk6CzJ8RNA8riBP2JwG", "language": "400", "code": "// Bad Request - Invalid quote or recipient information\n{\n \"error\": {\n \"code\": \"INVALID_DOCUMENT\",\n \"message\": \"Document not found or cannot be sent for signature\",\n \"details\": [\n \"\"\n ]\n }\n}" }, { "id": "V1ntcRHZcpNkPtj3ZiPBh", "language": "401", "code": "// Unauthorized - Invalid or missing API key\n{\n \"error\": {\n \"code\": \"INVALID_DOCUMENT\",\n \"message\": \"Document not found or cannot be sent for signature\",\n \"details\": [\n \"\"\n ]\n }\n}" }, { "id": "2BitybQKKZQE3jSpwmF89", "language": "404", "code": "// Not Found - Quote does not exist\n{\n \"error\": {\n \"code\": \"INVALID_DOCUMENT\",\n \"message\": \"Document not found or cannot be sent for signature\",\n \"details\": [\n \"\"\n ]\n }\n}" } ], "selectedLanguageId": "WhS5RhsmKJBb8MkNruWkx" } }, "children": [ { "text": "" } ] }