Creating and Sending a Transaction

This topic will walk you through the process to create and send a package using the Conga Sign API.

In this example a minimum payload is used, where two signers, one document, and one signature per signer are added to the package.

For a complete description of each field and other optional attributes, see the Request Payload Table below.

HTTP Request

POST <host domain>/api/sign/v1/sign/cs-packages

HTTP Headers

Authorization: Bearer access_token
Accept: application/json
Content-Type: multipart/form-data

Request Payload

------WebKitFormBoundary1bNO60n7FqP5WO4t Content-Disposition: form-data; name="file"; filename="testDocumentExtraction.pdf" Content-Type: application/pdf %PDF-1.5 %ÂµÂµÂµÂµ 1 0 obj <>>> endobj.... ------WebKitFormBoundary1bNO60n7FqP5WO4t Content-Disposition: form-data; name="payload" { "roles":[ { "id":"Role1", "signers":[ { "email":"signer1@example.com", "firstName":"1.firstname", "lastName":"1.lastname", "company":"Conga Sign" } ] }, { "id":"Role2", "signers":[ { "email":"signer2@example.com", "firstName":"2.firstname", "lastName":"2.lastname", "company":"Conga Sign" } ] } ], "documents":[ { "approvals":[ { "role":"Role1", "fields":[ { "page":0, "top":100, "subtype":"FULLNAME", "height":50, "left":100, "width":200, "type":"SIGNATURE" } ] }, { "role":"Role2", "fields":[ { "page":0, "top":300, "subtype":"FULLNAME", "height":50, "left":100, "width":200, "type":"SIGNATURE" } ] } ], "name":"Test Document" } ], "name":"Example Package", "type":"PACKAGE", "language":"en", "emailMessage":"", "description":"New Package", "autocomplete":true, "status":"SENT" } ------WebKitFormBoundary1bNO60n7FqP5WO4t--

Request Payload Table


Property	Type	Editable	Required	Default	Sample Values	Reference
roles						Adding, Updating, Removing Signers
id	string	Yes	No	n/a	Signer1
name	string	Yes	No	n/a	Signer1
emailMessage	array	Yes	No	n/a	check reference	Customizing Invitation Emails
reassign	boolean	Yes	No	0	true/false	Changing a Recipient
attachementRequirements	array	Yes	No	n/a	check reference	Managing Signers' Attachments
index	string	Yes	No	0	0/1/2/3	Creating a Signer Workflow
type	string	Yes	No	SIGNER	SIGNER/SENDER
signers
id	string	Yes	No	n/a	Signer1
email	string	Yes	Yes	n/a	signer1@example.com
firstName	string	Yes	Yes	n/a	Mary
lastName	string	Yes	Yes	n/a	Doe
company	string	Yes	No	n/a	Acme Inc.
title	string	Yes	No	null	Managing Director
group	array	Yes	No	n/a	check reference	Managing Groups
language	string	Yes	No	n/a	en/fr/es	Configure Languages
signature
textual	string	No	No	null
handdrawn	string	Yes	No	n/a	AQAAAAAMkGiVM7tmRJzS2cANoDcyT0ASAABWA=
delivery	array	Yes	No	n/a	check reference	Deliver Signed Documents
knowledgeBasedAuthentication	array	Yes	No	n/a	check reference	Authenticating Signers
auth	array	Yes	No	n/a	check reference	Authenticating Signers
documents						Uploading & Deleting Documents
description	string	Yes	No	n/a	Test document1 description
id	string	Yes	No	n/a	document1
data	array	Yes	No	n/a	check reference	Uploading & Deleting Documents
approvals						Adding Signatures
role	string	Yes	Yes	n/a	Signer1
id	string	Yes	No	n/a	approval1
optional	boolean	Yes	No	0	true/false	Configuring Optional Signatures
enforceCaptureSignature	boolean	Yes	No	0	true/false	Enforce Capture Signature
fields	array	Yes	No	n/a	check reference	Adding Fields
name	string	Yes	No	n/a	document 1
extract	boolean	Yes	No	0	true/false	Document Extraction/ Position Extraction
extractionTypes	array	Yes	No	n/a	["TEXT_TAGS","ACROFIELDS"]	Document Extraction/ Position Extraction
fields	array	Yes	No	n/a	check reference	Field Injection
name	string	Yes	No	n/a	document1
settings	array	Yes	No	n/a	check reference	Signer Experience Customization
sender
lastName	string	Yes	No	n/a	Smith
firstName	string	Yes	No	n/a	John
email	string	Yes	No	n/a	bobsmith@email.com (who is a sender under your main account)
status	string	Yes	No	DRAFT	DRAFT/SENT/COMPLETED/ARCHIVED/DECLINED/OPTED_OUT/EXPIRED
name	string	Yes	No	n/a	Package created from template through REST API
type	string	Yes	No	PACKAGE	PACKAGE/TEMPLATE/LAYOUT
description	string	Yes	No	n/a	Package created with the Conga Sign REST API
language	string	Yes	No	en	en/fr/es	Configure Languages
visibility	string	Yes	No	ACCOUNT	ACCOUNT/SENDER
autoComplete	boolean	Yes	No	1	true/false
data	array	Yes	No	n/a	check reference	Package Attribute
due	string	Yes	No	null	08-26-17
emailMessage	string	Yes	No	n/a	This message should be delivered to all signers

Response Payload

{
"id": "9sKhW-h-qS9m6Ho3zRv3n2a-rkI="
}

Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Creating and Sending a Transaction

Footer Section

Explore