SUsurense
Meetings

Create a meeting

Create a new meeting. The meeting can be linked to a lead by providing the leadId field.

post/meetings

Request

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

Request body

customerIdstring uuid required

Customer ID

leadIdstring uuid

Lead ID

subjectstring required

Meeting subject

notesstring

Meeting notes

type1 | 2 | 3 required

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

hostIdstring uuid required

Host ID

userAttendeesstring[]

User attendees

relatedAttendeesstring[]

Related attendees

startDatestring date-time required

Meeting start date

endDatestring date-time required

Meeting end date

locationstring

Meeting location

createEventboolean
sendToCustomerboolean

Whether to send the meeting invitation and notifications to the customer. Defaults to true.

Example request

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "leadId": "123e4567-e89b-12d3-a456-426614174000",
  "subject": "Client Review Meeting",
  "hostId": "123e4567-e89b-12d3-a456-426614174000",
  "userAttendees": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "relatedAttendees": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "startDate": "2024-01-15T10:00:00Z",
  "endDate": "2024-01-15T11:00:00Z",
  "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.