Newer Version Available

This content describes an older version of this product. View Latest

ApprovalSubmission

Represents the instance of an approval request that's submitted for a record of the related object. This object is available in API version 62.0 and later.

Supported Calls

describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update()

Special Access Rules

This object is available for users with a Salesforce user license of type Salesforce in Enterprise, Performance, Unlimited, and Developer Editions.

Fields

Field Details
Comments
Type
textarea
Properties
Nillable, Update
Description
The comments that the user adds when they submit the request for approval.
DoesSendApprovalEmail
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort, Update
Description
Required. Indicates whether approval request emails are sent to approvers and delegates (true) or not (false).
The default value is false.
FlowOrchestrationInstanceId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The ID of the flow orchestration instance record that's associated with the approval.
This field is a relationship field.
Relationship Name
FlowOrchestrationInstance
Refers To
FlowOrchestrationInstance
IsEligibleForSmartApproval
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the approval submission is eligible for smart approval (true) or not (false).
The default value is false.
This field is only available with Advanced Approvals enabled.
IsSmartApprovalRun
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether this approval submission either is run in smart approval mode (true) or not (false).
The default value is false.
This field is only available with Advanced Approvals enabled.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The sequentially-generated name of the approval submission record, for example AS-000000001.
OwnerId
Type
reference
Properties
Filter, Group, Sort, Update
Description
The ID of the user or the group that owns the approval submission record.
This field is a polymorphic relationship field.
Relationship Name
Owner
Refers To
User
RelatedRecordId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
Required. The API name of the related record that’s submitted for approval.
Relationship Name
RelatedRecord
Refers To
The objects that you have access to for approvals.
RelatedRecordObjectName
Type
string
Properties
Filter, Group, Nillable, Sort, Update
Description
Required. The type of record that was submitted for approval.
SmartApprvlBasisSubmissionId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The previous approval submission used as reference for the auto-approval evaluation.
This field is a relationship field.
This field is only available with Advanced Approvals enabled.
Relationship Name
SmartApprvlBasisSubmission
Refers To
ApprovalSubmission
Status
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort, Update
Description
Required. The status of the approval.
Valid values are:
  • Approved
  • Canceled
  • Errored
  • InProgress
  • Recalled
  • Rejected
  • Suspended
SubmittedById
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
Required. The ID of the user who submitted the record for approval.
This field is a relationship field.
Relationship Name
SubmittedBy
Refers To
User

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

ApprovalSubmissionShare
Sharing is available for the object.
ApprovalSubmissionHistory
History is available for tracked fields of the object.