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.

download

Creating Ad Hoc Approvals

This API creates an ad hoc approval step. This API accepts Context Request ID and creates an approval step for it.

API

Signature

createAdhocApproval

webService static Boolean createAdhocApproval(Id contextRequestId, String stepLabel, String assigneeType, Id assigneeId, String submissionComment, String relativeLocationToContext, List dependsOnContextRequestIdList, List dependsOnMeContextRequestIdList, Boolean sendEmail, Boolean notifyOnly)

createAdhocApproval

Request Parameters

Name

Type

Required?

Description

contextRequestIdID

Yes

ID of the context request in relation to which you want to create an approval step.

stepLabelString

Yes

Text label of the step

assigneeTypeString

Yes

Type of the assignee. Assignee can be:
  • User
  • Role
  • Related User
  • Queue
assigneeIDID

Yes

ID of the assignee.

submissionCommentString

Yes

Comments for approval submission.

relativeLocationToContextString

Yes

Relative location can be:
  • Before
  • After
  • In parallel
dependsOnContextRequestIdListList<ID>

Yes

List of request identifiers that the ad hoc approval depends on.

dependsOnMeContextRequestIdList

List<ID>

Yes

List of request identifiers that depend on this ad hoc approval.

sendEmail

Boolean

No

Set it as true to send an email request. The default value is true.

notifyOnly

Boolean

No

The default value is false.

Response Parameter

Name

Type

Description

resultBoolean

The API returns true when the ad hoc approval is created.