SUsurense
Leads

Update a checklist item

Update a checklist item. Scope leads:checklists:manage is required in order to update item's position or description, while the scope is not required to mark an item as done or not done.

patch/leads/{leadId}/checklists/{checkListId}/items/{itemId}

Request

  • Base URL
    https://api.surense.com/api/v1
  • URL
    https://api.surense.com/api/v1/leads/{leadId}/checklists/{checkListId}/items/{itemId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.surense.com/oauth/token scopes: leads:checklists:manage

Path parameters

leadIdstring uuid required

leadId

checkListIdstring uuid required

checkListId

itemIdstring uuid required

itemId

Request body

Response

OK

tenantIdstring uuid
agencyIdstring uuid
createdDatestring date-time
createdBystring uuid
creatorNamestring
lastModifiedDatestring date-time
lastModifiedBystring uuid
versioninteger
idstring uuid
numberinteger
externalIdstring
documentCountinteger
ownerIdstring uuid
ownerNamestring
assigneeIdstring uuid
assigneeNamestring
assignedUserIdstring uuid
assignedUserNamestring
assignedAtstring date-time
assignedBystring uuid
interestIdstring uuid
interestNamestring
statusIdstring uuid
statusNamestring
statusSuccessboolean
statusClosedboolean
statusDatestring date-time
lastStatusUpdateBystring uuid
priorityinteger
leadDatestring date-time
successDatestring date
closedDatestring date
closedReasonstring
dueDatestring date
dueTimestring
dueAtstring date-time
dueAtTimeSetboolean
overduePeriodstring
sourceIdstring uuid
existingLeadboolean
customerIdstring uuid
customerManagerIdstring uuid
customerManagersstring[]
idType1 | 2 | 3 | 4 | 5 | 6

Customer Identity Type:<br/>1 - ת.ז<br/>2 - דרכון<br/>3 - רישיון נהיגה<br/>4 - אחר<br/>5 - ח.פ<br/>6 - ח.צ

idNumberstring
idCardIssueDatestring date
firstNamestring
lastNamestring
customerFullNamestring
fullNamestring
customerFullNameReversestring
fullNameReversestring
cellNumberstring
phoneNumberstring
phoneNumber1string
phoneNumber2string
emailstring
otherEmailstring
customerStatusIdstring uuid
mailingStatus1 | 2 | 3 | 4

Mailing Status:<br/>1 - אושר דיוור<br/>2 - לא אושר דיוור<br/>3 - הוסר מדיוור<br/>4 - לא התבקש אישור

customerDeathboolean
swiftnessProxyInviteDatestring date
swiftnessProxySignDatestring date
swiftnessProxyExpiredboolean
lastE9100DataDatestring date
hbProxyInviteDatestring date
hbProxySignDatestring date
hbProxyExpiredboolean
hbDataDatestring date
policiesProxyInviteDatestring date
policiesProxySignDatestring date
streetstring
streetNumberstring
apartmentNumberstring
postalBoxinteger
citystring
postalCodeinteger
gender1 | 2 | 3

Gender:<br/>1 - לא מוגדר<br/>2 - זכר<br/>3 - נקבה

birthDatestring date
deathboolean
ageinteger
maritalStatus1 | 2 | 3 | 4 | 5

Marital Status:<br/>1 - רווק/ה<br/>2 - נשוי/אה<br/>3 - גרוש/ה<br/>4 - אלמן/ה<br/>5 - ידוע/ה בציבור

professionstring
monthlyIncomeinteger
notesstring
unseenboolean
employerNamestring
smokerboolean
meetingDatestring date
meetingTimestring
meetingFirstScheduledDatestring date-time
meetingFirstScheduledByIdstring uuid
meetingFirstScheduledByNamestring
meetingCoordinatedDatestring date-time
meetingCoordinatedByIdstring uuid
meetingCoordinatedByNamestring
meetingLocationstring
meetingCoordinatorIdstring uuid
meetingCoordinatorNamestring
tagsstring[]
lastActivityDatestring date-time
lastActivityBystring uuid
sharableboolean
appMailAddressstring
lastExternalPartyIdstring uuid
lastTransferDatestring date-time
utmIdstring
utmSourcestring
utmMediumstring
utmCampaignstring
utmTermstring
utmContentstring
contactPointCountinteger
lastContactPointDatestring date-time
typeIdstring uuid

Changes

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