Custom Transaction Data

Document attributes are customized data related to a document in a transaction, or to all data in a transaction. This data is not interpreted by Conga Sign. As such, the users of this data are free to store and interpret whatever data they want.

Customized data can also be applied at the transaction level. For more information, see Custom Document Data.

The following code shows you how to edit your DocumentPackage object to add package attributes.

HTTP Request

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

HTTP Headers

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

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" {
	"documents": [{
		"approvals": [{
			"id": "ExampleSignatureId",
			"role": "Signer1",
			"fields": [{
				"page": 0,
				"top": 200,
				"subtype": "LABEL",
				"height": 50,
				"left": 100,
				"width": 200,
				"id": "myLabelField",
				"type": "INPUT",
				"value": "Example label field value"
			}, {
				"page": 0,
				"top": 100,
				"subtype": "FULLNAME",
				"height": 50,
				"left": 100,
				"width": 200,
				"type": "SIGNATURE",
				"name": "ExampleSignatureId"
			}],
			"name": ""
		}],
		"id": "sample-contract",
		"name": "Test Document"
	}],
	"status": "DRAFT",
	"type": "PACKAGE",
	"roles": [{
		"id": "Signer1",
		"type": "SIGNER",
		"signers": [{
			"email": "signer1@example.com",
			"firstName": "John",
			"lastName": "Smith",
			"id": "Signer1"
		}],
		"name": "Signer1"
	}],
	"name": "Example Package",
	"data": {
		"First Name": "Bill",
		"Last Name": "Drake",
		"Signing Order": "1"
	}
}-- -- --WebKitFormBoundary1bNO60n7FqP5WO4t--

For a complete description of each field, see the Request Payload Table below.

Response Payload

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

Attributes are set on a package level. You will need to get your package JSON in order to retrieve your package attributes.

Request Payload Table


Property	Type	Editable	Required	Default	Sample Values
status	string	Yes	No	DRAFT	`DRAFT / SENT / COMPLETED / ARCHIVED / DECLINED / OPTED_OUT / EXPIRED`
type	string	Yes	No	PACKAGE	`PACKAGE / TEMPLATE / LAYOUT`
name	string	Yes	Yes	n/a	`Document Attributes Example`
documents
name	string	Yes	No	n/a	`sample doc`
id	string	Yes	No	n/a	`sample-contract`
approvals
fields
subtype	string	Yes	No	n/a	`FULLNAME / INITIALS / CAPTURE / MOBILE_CAPTURE /` `LABEL / TEXTFIELD / TEXTAREA / CHECKBOX / DATE / RADIO /` `LIST`
type	string	Yes	No	n/a	`SIGNATURE / INPUT`
extract	boolean	Yes	No	false	`true / false`
height	integer	Yes	No	50	50 / 100 / 150 ...
left	integer	Yes	No	0	50 / 100 / 150 ...
page	integer	Yes	No	0	0 / 1 / 2 ...
top	integer	Yes	No	0	50 / 100 / 150 ...
width	integer	Yes	No	200	50 / 100 / 150 ...
role	string	Yes	No	n/a	`Signer1`
id	string	Yes	No	n/a	`ExampleSignatureId`
roles
id	string	Yes	No	n/a	`Client1`
name	string	Yes	No	n/a	`Client1`
type	string	Yes	No	SIGNER	`SIGNER / SENDER`
signers
email	string	Yes	Yes	n/a	`john.smith@example.com`
firstName	string	Yes	Yes	n/a	`John`
lastName	string	Yes	Yes	n/a	`Smith`
phone	string	Yes	No	n/a	`514-555-8888`
id	string	Yes	No	n/a	`Client1`
company	string	Yes	No	n/a	`Acme Inc.`
title	string	Yes	No	n/a	`Managing Director`
data
First Name	string	Yes	No	n/a	`Bill`
Last Name	string	Yes	No	n/a	`Johnson`
Signing Order	string	Yes	No	n/a	1

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.

Custom Transaction Data

Footer Section

Explore