Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt

Use this file to discover all available pages before exploring further.

Update appointment 
PUT https://services.leadconnectorhq.com/calendars/events/appointments/{eventId}

​
Autorizacion

​
Authorization
string
required
Bearer token generado desde el portal Leadway. Ver Autenticacion.
​
Version
string
default:"2021-07-28"
required
Version de la API.

​
Path parameters

​
eventId
string
required
Event Id or Instance id. For recurring appointments send masterEventId to modify original series.

​
Body

​
title
string
default:"Test Event"
Title
​
meetingLocationType
string
default:"custom"
Meeting account type.
  • If address is provided in the request body, the meetingLocationType defaults to custom. Posibles valores: ‘custom’, ‘zoom’, ‘gmeet’, ‘phone’, ‘address’, ‘ms_teams’, ‘google’
​
meetingLocationId
string
default:"custom_0"
The unique identifier for the meeting account.
  • This value can be found in calendar.locationConfigurationsor calendar.teamMembers[].locationConfigurations
​
overrideLocationConfig
boolean
default:"True"
Flag to override account config
  • false - If only meetingLocationId is provided
  • true - If only meetingLocationType is provided
​
appointmentStatus
string
default:"confirmed"
Posibles valores: ‘new’, ‘confirmed’, ‘cancelled’, ‘showed’, ‘noshow’, ‘invalid’
​
assignedUserId
string
default:"0007BWpSzSwfiuSl0tR2"
Assigned User Id
​
description
string
default:"Booking a call to discuss the project"
Appointment Description
​
address
string
default:"Zoom"
Appointment Address
​
ignoreDateRange
boolean
default:"False"
If set to true, the minimum scheduling notice and date range would be ignored
​
toNotify
boolean
default:"False"
If set to false, the automations will not run
​
ignoreFreeSlotValidation
boolean
default:"True"
If true the time slot validation would be avoided for any appointment creation (even the ignoreDateRange)
​
rrule
string
RRULE as per the iCalendar (RFC 5545) specification for recurring events. DTSTART is not required, instance ids are calculated on the basis of startTime of the event. The rrule only be applied if ignoreFreeSlotValidation is true.
​
calendarId
string
default:"CVokAlI8fgw4WYWoCtQz"
Calendar Id
​
startTime
string
default:"2021-06-23T03:30:00+05:30"
Start Time
​
endTime
string
default:"2021-06-23T04:30:00+05:30"
End Time

​
Respuestas

​
calendarId
string
default:"CVokAlI8fgw4WYWoCtQz"
required
Calendar Id
​
locationId
string
default:"C2QujeCh8ZnC7al2InWR"
required
Account Id
​
contactId
string
default:"0007BWpSzSwfiuSl0tR2"
required
Contact Id
​
startTime
string
default:"2021-06-23T03:30:00+05:30"
Start Time
​
endTime
string
default:"2021-06-23T04:30:00+05:30"
End Time
​
title
string
default:"Test Event"
Title
​
meetingLocationType
string
default:"custom"
Meeting Account Type
​
appointmentStatus
string
default:"confirmed"
Posibles valores: ‘new’, ‘confirmed’, ‘cancelled’, ‘showed’, ‘noshow’, ‘invalid’, ‘active’, ‘completed’
​
assignedUserId
string
default:"0007BWpSzSwfiuSl0tR2"
Assigned User Id
​
address
string
default:"Zoom"
Appointment Address
​
isRecurring
boolean
default:"true"
true if the event is recurring otherwise false
​
rrule
string
RRULE as per the iCalendar (RFC 5545) specification for recurring events
​
id
string
default:"0TkCdp9PfvLeWKYRRvIz"
required
Id
{
  "calendarId": "CVokAlI8fgw4WYWoCtQz",
  "locationId": "C2QujeCh8ZnC7al2InWR",
  "contactId": "0007BWpSzSwfiuSl0tR2",
  "startTime": "2021-06-23T03:30:00+05:30",
  "endTime": "2021-06-23T04:30:00+05:30",
  "title": "Test Event",
  "meetingLocationType": "custom",
  "appointmentStatus": "confirmed",
  "assignedUserId": "0007BWpSzSwfiuSl0tR2",
  "address": "Zoom",
  "isRecurring": "true",
  "rrule": "string",
  "id": "0TkCdp9PfvLeWKYRRvIz"
}

{}

{}

​
Ejemplo

curl -X PUT 'https://services.leadconnectorhq.com/calendars/events/appointments/YOUR_eventId' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "Test Event",
  "meetingLocationType": "custom",
  "meetingLocationId": "custom_0",
  "overrideLocationConfig": true,
  "appointmentStatus": "confirmed",
  "assignedUserId": "0007BWpSzSwfiuSl0tR2",
  "description": "Booking a call to discuss the project",
  "address": "Zoom",
  "ignoreDateRange": false,
  "toNotify": false,
  "ignoreFreeSlotValidation": true,
  "rrule": "string",
  "calendarId": "CVokAlI8fgw4WYWoCtQz",
  "startTime": "2021-06-23T03:30:00+05:30",
  "endTime": "2021-06-23T04:30:00+05:30"
}'