Meetings

Update a meeting

patch/meetings/{id}

Request

  • Base URL
    https://api.surense.com/api/v1
  • URL
    https://api.surense.com/api/v1/meetings/{id}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.surense.com/oauth/token scopes: meetings:update

Path parameters

idstring uuid required

Meeting ID

Request body

status'SCHEDULED' | 'IN_PROGRESS' | 'COMPLETED' | 'CANCELLED' | 'NO_SHOW'

Meeting Status:<br/>SCHEDULED - Meeting is scheduled<br/>IN_PROGRESS - Meeting is currently in progress<br/>COMPLETED - Meeting has been completed<br/>CANCELLED - Meeting has been cancelled<br/>NO_SHOW - Meeting was not attended

subjectstring

Meeting subject

notesstring

Meeting notes

type'IN_PERSON' | 'VIDEO_CALL' | 'PHONE_CALL' | 'OTHER'

Meeting Type:<br/>IN_PERSON - In-person meeting<br/>VIDEO_CALL - Video call meeting<br/>PHONE_CALL - Phone call meeting<br/>OTHER - Other type of meeting

hostIdstring

Host ID

startDatestring

Meeting start date

endDatestring

Meeting end date

locationstring

Meeting location

reminderStatus1 | 2 | 3 | 4 | 5

Meeting Reminder Status:<br/>1 - Reminded_Approved (תוזכרה - מאושרת)<br/>2 - Reminded_Rescheduled (תוזכרה - נדחית)<br/>3 - Reminded_Canceled (תוזכרה - מבוטלת)<br/>4 - NoAnswer_Continue (אין מענה - להמשך טיפול)<br/>5 - NoAnswer_Canceled (אין מענה - ביטול)

sendToCustomerboolean

Whether to send the meeting invitation and notifications to the customer. Omit to leave unchanged.

Example request

{
  "status": "SCHEDULED",
  "subject": "Client Review Meeting",
  "notes": "Important discussion points",
  "type": "IN_PERSON",
  "hostId": "123e4567-e89b-12d3-a456-426614174000",
  "startDate": "2024-01-15T10:00:00Z",
  "endDate": "2024-01-15T11:00:00Z",
  "location": "Conference Room A",
  "reminderStatus": 1,
  "sendToCustomer": true
}

Response

OK

tenantIdstring uuid
agencyIdstring uuid
createdDatestring date-time
createdBystring uuid
creatorNamestring
lastModifiedDatestring date-time
lastModifiedBystring uuid
versioninteger
idstring uuid
numberinteger
documentCountinteger
customerIdstring uuid
customerFirstNamestring
customerLastNamestring
customerFullNamestring
customerFullNameReversestring
customerIdType1 | 2 | 3 | 4 | 5 | 6

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

customerIdNumberstring
customerManagersstring[]
customerStatusIdstring uuid
customerCellNumberstring
customerPhoneNumberstring
customerEmailstring
customerOtherEmailstring
customerGender1 | 2 | 3

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

leadIdstring uuid
leadNumberinteger
subjectstring
notesstring
type1 | 2 | 3

Meeting Type:<br/>1 - פגישה פרונטלית<br/>2 - פגישה מקוונת<br/>3 - פגישה טלפונית

hostIdstring uuid
userAttendeesstring[]
relatedAttendeesstring[]
status1 | 2 | 3 | 4 | 5
statusDatestring date-time
lastStatusUpdateBystring uuid
startDatestring date-time
endDatestring date-time
locationstring
tagsstring[]
lastActivityDatestring date-time
lastActivityBystring uuid
appMailAddressstring
reminderStatus1 | 2 | 3 | 4 | 5
reminderStatusLastUpdatedAtstring date-time
reminderStatusLastUpdatedBystring uuid
calLinkedboolean
sendToCustomerboolean

Changes

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