Promote a clause

post

https://xauthor-prod-rls10.congacloud.com/api/xauthor/v1/clauses/promote

This API promotes a marked clause from an agreement to the clause library, entering that clause into the clause library's clause repository. Once the clause is available in the clause library, you can reuse it for the original agreement record even after regenerating the document or you can make the clause available for other agreements and users.

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The request

referenceId

string | null

id

string | null

name

string | null

type

string | null

templateTypeObject

object

businessContext

string | null

businessObject

object

guidance

string | null

description

string | null

revisionDate

date-time

agreementTypes

string | null

category

string | null

subcategory

string | null

language

string | null

locale

string | null

localeId

string | null

keywords

string | null

isActive

boolean

mergefieldList

string | null

contentText

string | null

termException

string | null

termExceptionName

string | null

attachmentId

string | null

clonedFromId

string | null

clonedFromReferenceId

string | null

clonedFromTemplateName

string | null

needsPublishing

boolean

vf_PageName

string | null

activeVersionId

string | null

outputPage

string | null

createVisualForcePageEnum

int32

enum

Allowed:

formatFrameworkEnum

int32

enum

Allowed:

lastModifiedBy

string | null

lastModified

string | null

listAgreementTypes

array of objects | null

listAgreementTypes

checkoutVersionId

string | null

checkoutById

string | null

checkoutByName

string | null

checkoutDate

string | null

checkoutVersionName

string | null

sendForApprovalVersion

string | null

activeVersionName

string | null

activeVersionNumber

string | null

activeVersionComments

string | null

mergeFieldConsolidated

string | null

isAlternateClause

boolean

clauseType

string | null

eTag

string | null

externalId

string | null

enableAgreementClauseTracking

boolean

customProperties

object | null

createdBy

string | null

createdDate

string | null

clauseFormat

int32

enum

Allowed:

clauseBehavior

int32

enum

Allowed:

source

int32

enum

Allowed:

documentFileType

string | null

documentFileSize

int64

extendedProperties

string | null

stage

int32

enum

Allowed:

extractionReferenceId

string | null

isDraft

boolean | null

documentContent

string | null

suggestedFileName

string | null

saveOption

int32

enum

isTemplateVersioningEnabled

boolean

templateModeEnum

int32

enum

Allowed:

status

boolean

userRefreshedClause

boolean

localeEnabled

boolean

localeInfo

object

activate

boolean

updateCurrentVersion

boolean

aptDocumentProperties

string | null

documentContentType

string | null

gDocsUrl

string | null

metadata

object

checkoutTemplateName

string | null

Headers

OrgType

string

required

Defaults to RLP

accept

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

400

Bad Request

401

Unauthorized

404

Not Found

500

Server Error

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json