LeadOpptyStepCheckListRelations.update

Modifies LeadOpptyStepCheckListRelation or LeadOpptyStepCheckListRelations with given id(s)

Request

Path Params

string <uuid>

required

ID of LeadOpptyStepCheckListRelation to update

Query Params

validation-level

integer <int32>

optional

Specify validation level of LeadOpptyStepCheckListRelation 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.

Body Params application/json

cloud_object

object

optional

Relation to CloudObject, see: 'updateCloudObjectInput' object for properties.

string <uri>

optional

note

object

optional

Relation to Note, see: 'updateNoteInput' object for properties.

string <uri>

optional

activity_id

string <uuid>

optional

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

Example:

01234567-abcd-dcba-ffff-000000000000

cloud_object_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

email_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

item_checked

boolean

optional

Boolean value.

Example:

false

lead_oppty_id

string <uuid>

optional

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

Example:

01234567-abcd-dcba-ffff-000000000000

note_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

quote_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

step_checklist_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

Example

{
    "cloud_object": {
        "id": "http://example.com"
    },
    "note": {
        "id": "http://example.com"
    },
    "activity_id": "01234567-abcd-dcba-ffff-000000000000",
    "cloud_object_id": "01234567-abcd-dcba-ffff-000000000000",
    "email_id": "01234567-abcd-dcba-ffff-000000000000",
    "item_checked": false,
    "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
    "note_id": "01234567-abcd-dcba-ffff-000000000000",
    "quote_id": "01234567-abcd-dcba-ffff-000000000000",
    "step_checklist_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Modification confirmation. Returns resulting LeadOpptyStepCheckListRelation

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (LeadOpptyStepCheckListRelation)

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

appointment

string <uri>

optional

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

task

string <uri>

optional

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

cloud_object

string <uri>

optional

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

string <uri>

optional

Relation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' 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.

note

string <uri>

optional

Relation to Note. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Note' 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.

step_checklist

string <uri>

required

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

activity_id

string <uuid>

optional

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

Example:

01234567-abcd-dcba-ffff-000000000000

cloud_object_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

email_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

item_checked

boolean

optional

Boolean value.

Example:

false

lead_oppty_id

string <uuid>

optional

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

Example:

01234567-abcd-dcba-ffff-000000000000

note_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

quote_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

step_checklist_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

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",
        "appointment": "http://example.com",
        "task": "http://example.com",
        "cloud_object": "http://example.com",
        "email": "http://example.com",
        "lead": "http://example.com",
        "oppty": "http://example.com",
        "note": "http://example.com",
        "quote": "http://example.com",
        "step_checklist": "http://example.com",
        "activity_id": "01234567-abcd-dcba-ffff-000000000000",
        "cloud_object_id": "01234567-abcd-dcba-ffff-000000000000",
        "email_id": "01234567-abcd-dcba-ffff-000000000000",
        "item_checked": false,
        "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
        "note_id": "01234567-abcd-dcba-ffff-000000000000",
        "quote_id": "01234567-abcd-dcba-ffff-000000000000",
        "step_checklist_id": "01234567-abcd-dcba-ffff-000000000000",
        "revision": 1
    }
}

🟠404Record Not Found

🔴500Server Error