Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Approval

Approvals.update

Modifies Approval or Approvals with given id(s)

patch/entities/Approvals/{id}

Path parameters

idstring uuid required

ID of Approval to update

Query parameters

validation-levelinteger

Specify validation level of Approval on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

account_idstring uuid

Id of the linked account.

actor_idstring uuid

Id of the triggering user.

application_idstring uuid

Id of the application.

approval_process_idstring uuid

Id of the approval process.

approval_status0 | 1 | 2

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 0 - Pending, 1 - Approved, 2 - Rejected

commentstring

Comment the requester attached when raising the approval.

contact_idstring uuid

Id of the linked contact.

lead_oppty_idstring uuid

Id of the linked lead or opportunity, or empty when not linked.

quote_idstring uuid

Id of the linked quote.

status1 | 2 | 3 | 4 | 5

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "account_id": "01234567-abcd-dcba-ffff-000000000000",
  "actor_id": "01234567-abcd-dcba-ffff-000000000000",
  "application_id": "01234567-abcd-dcba-ffff-000000000000",
  "approval_process_id": "01234567-abcd-dcba-ffff-000000000000",
  "comment": "string",
  "contact_id": "01234567-abcd-dcba-ffff-000000000000",
  "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
  "quote_id": "01234567-abcd-dcba-ffff-000000000000",
  "status": 1,
  "revision": 1
}

Response

Modification confirmation. Returns resulting Approval

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "account_id": "01234567-abcd-dcba-ffff-000000000000",
    "actor_id": "01234567-abcd-dcba-ffff-000000000000",
    "application_id": "01234567-abcd-dcba-ffff-000000000000",
    "approval_process_id": "01234567-abcd-dcba-ffff-000000000000",
    "comment": "string",
    "contact_id": "01234567-abcd-dcba-ffff-000000000000",
    "end_time": "2019-01-01T00:00:00",
    "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
    "quote_id": "01234567-abcd-dcba-ffff-000000000000",
    "status": 1,
    "revision": 1,
    "start_time": "2019-01-01T00:00:00"
  }
}