COcoevera
Approval

Approvals.update

Changes fields of the Approval record with the given id; fields left out keep their values.

patch/entities/Approvals/{id}

Request

Path parameters

idstring uuid required

Id of the Approval record to update.

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

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 (e.g. browser, automation, third-party integration) the approval was triggered in.

approval_process_idstring uuid

Id of the approval process this approval was raised from.

approval_status0 | 1 | 2

Decision state of the approval: Pending while waiting for the approvers, then Approved or Rejected. end_time is set once the decision is made.

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

Result of the approval process run: the most severe status among its activity log lines, Error when a step of the run failed. The decision itself is in approval_status.

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

The changed Approval record.

successboolean

True when the request 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"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.