Approvals.create - PipelinerCRM

Creates new Approval

Request

Query Params

validation-level

integer <int32>

optional

Specify validation level of Approval on create. 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.

Body Params application / json

account_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

actor_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

application_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

approval_process_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

approval_status

enum<integer>

optional

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

Allowed values:

012

Example:

comment

string

optional

Multi-line text input field.

Example:

string

contact_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

lead_oppty_id

string <uuid>

optional

Relation to single abstract entity instance.
E.g. Relation to Lead/Oppty

Example:

01234567-abcd-dcba-ffff-000000000000

quote_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

status

enum<integer>

optional

Integer enum value: 1 - Ok, 2 - Warning, 3 - Error

Allowed values:

123

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

approvers

array [object {1}]

optional

Relations to ApprovalApprovers.

string <uri>

optional

Example

{
    "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",
    "approval_status": 0,
    "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,
    "approvers": [
        {
            "id": "http://example.com"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Creation confirmation. Returns created Approval

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (Approval)

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

account

string <uri>

optional

Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties.

actor

string <uri>

optional

Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.

application

string <uri>

required

Relation to Application. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Application' object for properties.

approval_process

string <uri>

required

Relation to ApprovalProcess. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ApprovalProcess' object for properties.

contact

string <uri>

optional

Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties.

lead

string <uri>

optional

Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties.

oppty

string <uri>

optional

Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties.

quote

string <uri>

optional

Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties.

account_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

actor_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

application_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

approval_process_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

approval_status

enum<integer>

optional

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

Allowed values:

012

Example:

comment

string

optional

Multi-line text input field.

Example:

string

contact_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

end_time

string <date-time>

optional

Datetime information.

Example:

2019-01-01T00:00:00

lead_oppty_id

string <uuid>

optional

Relation to single abstract entity instance.
E.g. Relation to Lead/Oppty

Example:

01234567-abcd-dcba-ffff-000000000000

quote_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

settings

object

required

Field containing json.

status

enum<integer>

optional

Integer enum value: 1 - Ok, 2 - Warning, 3 - Error

Allowed values:

123

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

approvers

array[string <uri>]

optional

Relations to ApprovalApprovers.

lines

array[string <uri>]

optional

Relations to ApprovalProcessActivityLogLines.

start_time

string <date-time>

optional

Example:

2019-01-01T00:00:00

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "account": "http://example.com",
        "actor": "http://example.com",
        "application": "http://example.com",
        "approval_process": "http://example.com",
        "contact": "http://example.com",
        "lead": "http://example.com",
        "oppty": "http://example.com",
        "quote": "http://example.com",
        "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",
        "approval_status": 0,
        "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",
        "settings": {},
        "status": 1,
        "revision": 1,
        "approvers": [
            "http://example.com"
        ],
        "lines": [
            "http://example.com"
        ],
        "start_time": "2019-01-01T00:00:00"
    }
}

🔴500Server Error