Create appointment

POSThttps://services.leadconnectorhq.com/calendars/events/appointments
Create appointment
Request

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123
Path Parameters
groupId
string
required

Group Id

Example:
ocQHyuzHvysMo5N5VsXc
Headers
Authorization
string
required

Access Token

Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
string
required

API Version

Allowed value:
2021-04-15
Body
title
string

Title

Example:
Test Event
meetingLocationType
string

Meeting location type.

  • If address is provided in the request body, the meetingLocationType defaults to custom.
Allowed values:
customzoomgmeetphoneaddressms_teamsgoogle
Example:
custom
meetingLocationId
string

The unique identifier for the meeting location.

  • This value can be found in calendar.locationConfigurationsor calendar.teamMembers[].locationConfigurations
Default:
default
Example:
custom_0
overrideLocationConfig
boolean

Flag to override location config

  • false - If only meetingLocationId is provided
  • true - If only meetingLocationType is provided
Example:
true
appointmentStatus
string
Allowed values:
newconfirmedcancelledshowednoshowinvalid
Example:
confirmed
assignedUserId
string

Assigned User Id

Example:
0007BWpSzSwfiuSl0tR2
address
string

Appointment Address

Example:
Zoom
ignoreDateRange
boolean

If set to true, the minimum scheduling notice and date range would be ignored

Example:
false
toNotify
boolean

If set to false, the automations will not run

Example:
false
ignoreFreeSlotValidation
boolean

If true the time slot validation would be avoided for any appointment creation (even the ignoreDateRange)

Example:
true
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.

Examples:
RRULE:FREQ=DAILY;INTERVAL=1;COUNT=5RRULE:FREQ=DAILY;INTERVAL=1;UNTIL=20210623T043000Z EXDATE:20211105T040000Z,20211105T040000Z
calendarId
string
required

Calendar Id

Example:
CVokAlI8fgw4WYWoCtQz
locationId
string
required

Location Id

Example:
C2QujeCh8ZnC7al2InWR
contactId
string
required

Contact Id

Example:
0007BWpSzSwfiuSl0tR2
startTime
string
required

Start Time

Example:
2021-06-23T03:30:00+05:30
endTime
string

End Time

Example:
2021-06-23T04:30:00+05:30

Responses

Successful response

Body

calendarId
string
required

Calendar Id

Example:
CVokAlI8fgw4WYWoCtQz
locationId
string
required

Location Id

Example:
C2QujeCh8ZnC7al2InWR
contactId
string
required

Contact Id

Example:
0007BWpSzSwfiuSl0tR2
startTime
string

Start Time

Example:
2021-06-23T03:30:00+05:30
endTime
string

End Time

Example:
2021-06-23T04:30:00+05:30
title
string

Title

Example:
Test Event
meetingLocationType
string

Meeting Location Type

Default:
default
Example:
custom
appointmentStatus
string
Allowed values:
newconfirmedcancelledshowednoshowinvalid
Example:
confirmed
assignedUserId
string

Assigned User Id

Example:
0007BWpSzSwfiuSl0tR2
address
string

Appointment Address

Example:
Zoom
isRecurring
boolean

true if the event is recurring otherwise false

Example:
true
rrule
string

RRULE as per the iCalendar (RFC 5545) specification for recurring events

Examples:
RRULE:FREQ=DAILY;INTERVAL=1;COUNT=5RRULE:FREQ=DAILY;INTERVAL=1;UNTIL=20210623T043000Z EXDATE:20211105T040000Z,20211105T040000Z
id
string
required

Id

Example:
0TkCdp9PfvLeWKYRRvIz

Unprocessable Entity

Body

statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity

Unauthorized

Body

statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized

Bad Request

Body

statusCode
number
Example:
400
message
string
Example:
Bad Request