Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Lead & Opportunity

LeadOpptyStepCheckListRelations.update

Modifies LeadOpptyStepCheckListRelation or LeadOpptyStepCheckListRelations with given id(s)

patch/entities/LeadOpptyStepCheckListRelations/{id}

Path parameters

idstring uuid required

ID of LeadOpptyStepCheckListRelation to update

Query parameters

validation-levelinteger

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.

Request body

activity_idstring uuid

Id of the appointment or task linked as evidence for this checklist item.

cloud_object_idstring uuid

Id of the document.

email_idstring uuid

Id of the email.

item_checkedboolean

True when the checklist item has been completed for this lead, opportunity or quote.

lead_oppty_idstring uuid

Id of the lead or opportunity, or empty when this completion belongs to a quote.

note_idstring uuid

Id of the note.

quote_idstring uuid

Id of the quote.

step_checklist_idstring uuid

Id of the step checklist item.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "activity_id": "01234567-abcd-dcba-ffff-000000000000",
  "cloud_object_id": "01234567-abcd-dcba-ffff-000000000000",
  "email_id": "01234567-abcd-dcba-ffff-000000000000",
  "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
}

Response

Modification confirmation. Returns resulting LeadOpptyStepCheckListRelation

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",
    "activity_id": "01234567-abcd-dcba-ffff-000000000000",
    "cloud_object_id": "01234567-abcd-dcba-ffff-000000000000",
    "email_id": "01234567-abcd-dcba-ffff-000000000000",
    "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
  }
}