home

Sign for Advantage Platform

Adobe Sign ServicesAdvantage Platform AdministrationApprovals for Advantage PlatformApprovals for SalesforceBilling for Advantage PlatformBilling for SalesforceCLM for Advantage PlatformCLM for SalesforceContracts for SalesforceCollaborateComposer for Advantage PlatformComposer for SalesforceContractsConga for Google DocsConga Upgrade ProgramContract Intelligence (Standalone)Conga CopilotCPQ for Advantage PlatformCPQ for SalesforceDeal MaximizerDigital Commerce for Advantage PlatformDigital Commerce for SalesforceDiscovery AI for Advantage PlatformDiscovery AI for SalesforceDocusign ServiceseSignature Integration with Advantage PlatformGridInvoice GenerationMix FormsOrchestrateOrder Management for Advantage PlatformOrder Management for SalesforcePartner Commerce for Advantage PlatformPartner Commerce for SalesforceQuote GenerationSign for Advantage PlatformSign for SalesforceSmart SearchTest AuthorTurboEnginesX-Author for Contracts 1.0 (Classic)X-Author for ContractsX-Author for Contracts Advanced for Advantage PlatformX-Author for Contracts Advanced for SalesforceX-Author for ExcelX-Author for Migration Manager for Advantage PlatformX-Author for Migration ManagerRelease NotesGeneral
search
search
Adobe Sign ServicesAdvantage Platform AdministrationApprovals for Advantage PlatformApprovals for SalesforceBilling for Advantage PlatformBilling for SalesforceCLM for Advantage PlatformCLM for SalesforceContracts for SalesforceCollaborateComposer for Advantage PlatformComposer for SalesforceContractsConga for Google DocsConga Upgrade ProgramContract Intelligence (Standalone)Conga CopilotCPQ for Advantage PlatformCPQ for SalesforceDeal MaximizerDigital Commerce for Advantage PlatformDigital Commerce for SalesforceDiscovery AI for Advantage PlatformDiscovery AI for SalesforceDocusign ServiceseSignature Integration with Advantage PlatformGridInvoice GenerationMix FormsOrchestrateOrder Management for Advantage PlatformOrder Management for SalesforcePartner Commerce for Advantage PlatformPartner Commerce for SalesforceQuote GenerationSign for Advantage PlatformSign for SalesforceSmart SearchTest AuthorTurboEnginesX-Author for Contracts 1.0 (Classic)X-Author for ContractsX-Author for Contracts Advanced for Advantage PlatformX-Author for Contracts Advanced for SalesforceX-Author for ExcelX-Author for Migration Manager for Advantage PlatformX-Author for Migration ManagerRelease NotesGeneral

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.

search

Sign for Advantage Platform

chevron_left

Sign for Advantage Platform Contents

close
  • About Conga Sign

  • What's New in Conga Sign Documentation

  • chevron_right

    Conga Sign for Administrators

  • chevron_right

    Conga Sign for Users

  • expand_more

    Conga Sign for REST API Developers

    • expand_more

      Conga Sign REST APIs

      • chevron_right

        AccountRoles

      • chevron_right

        AccountSigningLogos

      • chevron_right

        AccountSigningTheme

      • chevron_right

        AccountSigningUIOptions

      • chevron_right

        Approval

      • chevron_right

        AuthenticationTokens

      • chevron_right

        CustomerRegistration

      • chevron_right

        CustomFields

      • chevron_right

        DataManagement

      • expand_more

        Documents

        • Retrieve the specified document

          get
        • Update the specified document

          put
        • Update a document

          post
        • Delete a document from a package

          delete
        • Retrieve zipped documents

          get
        • Retrieve document visibility information

          get
        • Update document visibility

          post
        • Retrieve an original PDF document

          get
        • Retrieve a specific document in PDF form

          get
        • Retrieve a page

          get
        • Update documents

          put
        • Add a new document to an existing package

          post
        • Delete multiple documents from a package

          delete
        • Create a signature confirmation

          post
        • Sign all documents in a package

          post
        • Apply a layout to a document

          post
      • chevron_right

        FileAttachment

      • chevron_right

        Groups

      • chevron_right

        IdvWorkflow

      • chevron_right

        InAppReports

      • chevron_right

        Layout

      • chevron_right

        Notification

      • chevron_right

        Package

      • chevron_right

        Reminder

      • chevron_right

        Reports

      • chevron_right

        Role

      • chevron_right

        RolesVerification

      • chevron_right

        Sender

      • chevron_right

        Session

      • chevron_right

        SubAccounts

      • chevron_right

        VirtualRoom

    • Minimum Software Requirements

    • chevron_right

      Connecting Conga Sign API to Salesforce

    • Embedding Conga Sign into Salesforce Using Public REST APIs or from Salesforce Object button on UI

    • Conga Sign API Region Endpoints

    • Creating an Integration User for Sign API

    • Obtain the JWT access token

    • Authentication Tokens

    • Setting Up Callback Notifications

    • Available Notifications

    • Receiving Event notifications

    • To set up Callback Notifications

    • Using the Signer Experience

    • Storing Signing Session Data

    • chevron_right

      Supported Languages

    • chevron_right

      Creating and Sending a Transaction

    • Adding, Updating, Removing Signers

    • Document Extraction

    • Uploading & Deleting Documents

    • Customizing Invitation Emails

    • chevron_right

      Injecting Field Values

    • Supported Fonts

    • Managing Groups

    • Authenticating Signers

    • Enforcing Signature Capture

    • Custom Transaction Data

    • Custom Document Data

    • Mobile Signing Ceremony

    • Text Tag Extraction

    • Position Extraction

    • Signer Experience Settings

    • Text Anchors

    • Conga Sign API Runbook with Postman Collections

  • chevron_right

    Conga Sign Features by Release

  • Conga Customer Community & Learning Center Resources

  1. Sign for Advantage Platform (current)
  2. arrow_right
  3. Conga Sign for REST API Developers
  4. arrow_right
  5. Conga Sign REST APIs

list_altShow Contents

chevron_left

Sign for Advantage Platform

Documents

chevron_right
download

Apply a layout to a document

post
https://coreapps-rlsdev.congacloud.io/api/sign
/v1/cs-packages/{packageId}/documents/{documentId}/layout

Applies a specific layout to a specified document. At least one parameter needs to be applied, either layoutID, or layoutName.

Request

Security: API Key

Path Parameters

documentId
string or null
required

The unique document id.

packageId
string or null
required

The unique package id.

Query Parameters

layoutId
string or null

The unique layout id.

layoutName
string or null

The unique layout name.

removeOutOfBound
boolean

Default value : false

Default:
false

Responses

204
400
401
403
404
500

No Content

Body

responses
/
204
status
string

Status of the document

approvals
array[object]

List of approvals for the document

accepted
string<date-time> or null

Date of approval acceptance.

data
dictionary[string, any]

Additional approval ata properties.

fields
array[object]

Approval Signature/Input fields.

id
string

The unique approval Id.

name
string

The unique approval name.

role
string

The approval role name.

signed
string<date-time> or null

The approval signed date.

optional
boolean

Check if for optional information.

enforceCaptureSignature
boolean

Check if required on Capture Signature

data
dictionary[string, any]

Custom data for the document

description
string

Document description

external
object

External integration provider settings.

data
object

Provider metadata.

id
string

External integration Id.

provider
string

Provider method.

providerName
string

Provider name.

extract
boolean or null
tagged
boolean or null

Tagged

extractionTypes
array[string]

ExtractionTypes

fields
array[object]

List of fields in the document

binding
string

Binding

data
dictionary[string, any]

Custom data for the field

extract
boolean

Determines if field is to be extracted

extractAnchor
object

Text extraction anchor object.

height
number<double>

Field height.

id
string

Field Id.

left
number<double>

X coordinate of the field

name
string

Field name.

page
integer<int32>

The document page where the field is located

subtype
string

Field subtype

top
number<double>

Y coordinate of the field

type
string
Allowed values:
SIGNATUREINPUTIMAGE
validation
object

Field validation object

value
string

The field value

fontSize
integer<int32> or null

Field font size.

width
number<double>

Field width.

id
string

Unique id of the document

index
integer<int32> or null

Index of the document within the package

name
string

The document name

pages
array[object]

List of page objects within the document

height
number<double> or null

Page height

id
string

Unique page id

index
integer<int32> or null

Index of the page within the document

left
number<double> or null

Page left

top
number<double> or null

Page top

version
integer<int32> or null

Version

width
number<double> or null

Page width

size
integer<int32> or null

The size of the document in bytes

signedHash
string

Signed hash

signerVerificationToken
string

SignerVerificationToken

Auth
:
Parameters
:
:
:
:
:
curl --request POST \
--url https://coreapps-rlsdev.congacloud.io/api/sign/v1/cs-packages/packageId/documents/documentId/layout \
--header 'Accept: application/json' \
--header 'Authorization: 123' \
--header 'Content-Type: application/json'
Response Example
1
{
2
"status": "string",
3
"approvals": [
4
{
5
"accepted": "2019-08-24T14:15:22Z",
6
"data": {
7
"property1": null,
8
"property2": null
9
},
10
"fields": [
11
{
12
"binding": "string",
13
"data": {
14
"property1": null,
15
"property2": null
16
},
17
"extract": true,
18
"extractAnchor": {
19
"anchorPoint": "TOPLEFT",
20
"characterIndex": 0,
21
"height": 0,
22
"index": 0,
23
"leftOffset": 0,
24
"text": "string",
25
"topOffset": 0,
26
"width": 0
27
},
28
"height": 0,
29
"id": "string",
30
"left": 0,
31
"name": "string",
32
"page": 0,
33
"subtype": "string",
34
"top": 0,
35
"type": "SIGNATURE",
36
"validation": {
37
"enum": [
38
"string"
39
],
40
"errorCode": 0,
41
"errorMessage": "string",
42
"maxLength": 0,
43
"minLength": 0,
44
"pattern": "string",
45
"required": true,
46
"group": "string",
47
"minimumRequired": 0
48
},
49
"value": "string",
50
"fontSize": 0,
51
"width": 0
52
}
53
],
54
"id": "string",
55
"name": "string",
56
"role": "string",
57
"signed": "2019-08-24T14:15:22Z",
58
"optional": true,
59
"enforceCaptureSignature": true
60
}
61
],
62
"data": {
63
"property1": null,
64
"property2": null
65
},
66
"description": "string",
67
"external": {
68
"data": {
69
"property1": null,
70
"property2": null
71
},
72
"id": "string",
73
"provider": "string",
74
"providerName": "string"
75
},
76
"extract": true,
77
"tagged": true,
78
"extractionTypes": [
79
"string"
80
],
81
"fields": [
82
{
83
"binding": "string",
84
"data": {
85
"property1": null,
86
"property2": null
87
},
88
"extract": true,
89
"extractAnchor": {
90
"anchorPoint": "TOPLEFT",
91
"characterIndex": 0,
92
"height": 0,
93
"index": 0,
94
"leftOffset": 0,
95
"text": "string",
96
"topOffset": 0,
97
"width": 0
98
},
99
"height": 0,
100
"id": "string",
101
"left": 0,
102
"name": "string",
103
"page": 0,
104
"subtype": "string",
105
"top": 0,
106
"type": "SIGNATURE",
107
"validation": {
108
"enum": [
109
"string"
110
],
111
"errorCode": 0,
112
"errorMessage": "string",
113
"maxLength": 0,
114
"minLength": 0,
115
"pattern": "string",
116
"required": true,
117
"group": "string",
118
"minimumRequired": 0
119
},
120
"value": "string",
121
"fontSize": 0,
122
"width": 0
123
}
124
],
125
"id": "string",
126
"index": -2147483648,
127
"name": "string",
128
"pages": [
129
{
130
"height": 0,
131
"id": "string",
132
"index": 0,
133
"left": 0,
134
"top": 0,
135
"version": 0,
136
"width": 0
137
}
138
],
139
"size": -2147483648,
140
"signedHash": "string",
141
"signerVerificationToken": "string"
142
}
chevron_leftchevron_right
chevron_right

Footer Section

Explore


Conga.com
Legal
Feedback
Contact Support

Copyright © 2025 Conga Corporation • All Rights Reserved

Cookie Notice

We use cookies to improve your experience on our site. To find out more, read our cookie policy.