Create Appointment

POST https://services.leadconnectorhq.com/calendars/events/appointments

Crear cita

Request

Security: Bearer Auth

Utiliza el Access Token generado con tipo de usuario Subcuenta o el Token de Integración Privada de la Subcuenta en PowerLeads. Proporciona tu token Bearer en el encabezado Authorization al realizar solicitudes a recursos protegidos.

Example: Authorization: Bearer 123

Headers

Authorization string (required)
Access Token
Example: Bearer 9c84df2694a849b6089f9d0d3513efe

Version string (required)
API Version
Allowed value: 2021-04-15

Body

title string
Title
Example: Test Event

meetingLocationType string
Meeting location type.
Allowed values: custom, zoom, gmeet, phone, address, ms_teams, google
Example: custom

meetingLocationId string
The unique identifier for the meeting location.
Default: default
Example: custom_0

overrideLocationConfig boolean
Flag to override location config.
Example: true

appointmentStatus string
Allowed values: new, confirmed, cancelled, showed, noshow, invalid
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.
Examples:
RRULE:FREQ=DAILY;INTERVAL=1;COUNT=5
RRULE: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 201

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: new, confirmed, cancelled, showed, noshow, invalid
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=5
RRULE:FREQ=DAILY;INTERVAL=1;UNTIL=20210623T043000Z EXDATE:20211105T040000Z,20211105T040000Z

id string (required)
Id
Example: 0TkCdp9PfvLeWKYRRvIz

curl --request POST \
  --url https://services.leadconnectorhq.com/calendars/events/appointments \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 123' \
  --header 'Content-Type: application/json' \
  --header 'Version: 2021-04-15' \
  --data '{
  "title": "Test Event",
  "meetingLocationType": "custom",
  "meetingLocationId": "default",
  "overrideLocationConfig": true,
  "appointmentStatus": "new",
  "assignedUserId": "0007BWpSzSwfiuSl0tR2",
  "address": "Zoom",
  "ignoreDateRange": false,
  "toNotify": false,
  "ignoreFreeSlotValidation": true,
  "rrule": "RRULE:FREQ=DAILY;INTERVAL=1;COUNT=5",
  "calendarId": "CVokAlI8fgw4WYWoCtQz",
  "locationId": "C2QujeCh8ZnC7al2InWR",
  "contactId": "0007BWpSzSwfiuSl0tR2",
  "startTime": "2021-06-23T03:30:00+05:30",
  "endTime": "2021-06-23T04:30:00+05:30"
}'

Response Example

{
  "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": "default",
  "appointmentStatus": "new",
  "assignedUserId": "0007BWpSzSwfiuSl0tR2",
  "address": "Zoom",
  "isRecurring": "true",
  "rrule": "RRULE:FREQ=DAILY;INTERVAL=1;COUNT=5",
  "id": "0TkCdp9PfvLeWKYRRvIz"
}

Create Appointment

Request

Headers

Body

Responses Successful response 201

Body

Responses
Successful response 201