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.

Show Page Sections

download

Configuring Languages

The languages that are available during the creation of a transaction or during the Signer Experience can be customized. The languages available for Sign are listed in Supported Languages.

Changing a Language at the Transaction Level

The following request shows you how to build your JSON payload in order to change the language settings at both the transaction level, as well as at the signer level:

HTTP Request

POST /api/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"   {   "status": "DRAFT",   "language": "fr",   "roles": [   {   "id": "Signer1",   "type": "SIGNER",   "signers": [   {   "id": "Signer1",   "firstName": "John",   "lastName": "Smith",   "email": "signer1@example.com"   }   ],   "name": "Signer1"   },   {   "id": "Signer2",   "type": "SIGNER",   "signers": [   {   "id": "Signer2",   "firstName": "Mary",   "lastName": "Doe",   "email": "signer2@example.com",   "language": "en"   }   ],   "name": "Signer1"   }   ],   "type": "PACKAGE",   "name": "Example Package"   }   ------WebKitFormBoundary1bNO60n7FqP5WO4t--  

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

Response Payload

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

Note that the language is set on a transaction level. The language will be changed for all recipients in the transaction.

Request Payload Table

Property

Type

Editable

Required

Default

Sample Values

status

string

Yes

No

DRAFT

DRAFT/SENT/COMPLETED/ARCHIVED/DECLINED/OPTED_OUT/EXPIRED

language

string

Yes

No

en

en/fr/es ...

type

string

Yes

No

PACKAGE

PACKAGE/TEMPLATE/LAYOUT

name

string

Yes

No

n/a

Example Package

roles

id

string

Yes

No

n/a

Signer1

type

string

Yes

No

SIGNER

SIGNER/SENDER

name

string

Yes

No

n/a

Signer1

signers

email

string

Yes

Yes

n/a

signer1@example.com

firstName

string

Yes

Yes

n/a

John

lastName

string

Yes

Yes

n/a

Smith

id

string

Yes

Yes

n/a

Signer1

language

string

Yes

Yes

en

en/fr/es ...