Create appointment

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

Autorización

string

required

Bearer token generado desde el portal Leadway. Ver Autenticación.

string

default:"2021-07-28"

required

Versión de la API.

Body

string

default:"Test Event"

Title

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’

string

default:"custom_0"

The unique identifier for the meeting account.

This value can be found in calendar.locationConfigurationsor calendar.teamMembers[].locationConfigurations

boolean

default:"True"

Flag to override account config

false - If only meetingLocationId is provided
true - If only meetingLocationType is provided

string

default:"confirmed"

Posibles valores: ‘new’, ‘confirmed’, ‘cancelled’, ‘showed’, ‘noshow’, ‘invalid’

string

default:"0007BWpSzSwfiuSl0tR2"

Assigned User Id

string

default:"Booking a call to discuss the project"

Appointment Description

string

default:"Zoom"

Appointment Address

boolean

default:"False"

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

boolean

default:"False"

If set to false, the automations will not run

boolean

default:"True"

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

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.

string

default:"CVokAlI8fgw4WYWoCtQz"

required

Calendar Id

string

default:"C2QujeCh8ZnC7al2InWR"

required

Account Id

string

default:"0007BWpSzSwfiuSl0tR2"

required

Contact Id

string

default:"2021-06-23T03:30:00+05:30"

required

Start Time

string

default:"2021-06-23T04:30:00+05:30"

End Time

Respuestas

200 - Successful response

string

default:"CVokAlI8fgw4WYWoCtQz"

required

Calendar Id

string

default:"C2QujeCh8ZnC7al2InWR"

required

Account Id

string

default:"0007BWpSzSwfiuSl0tR2"

required

Contact Id

string

default:"2021-06-23T03:30:00+05:30"

Start Time

string

default:"2021-06-23T04:30:00+05:30"

End Time

string

default:"Test Event"

Title

string

default:"custom"

Meeting Account Type

string

default:"confirmed"

Posibles valores: ‘new’, ‘confirmed’, ‘cancelled’, ‘showed’, ‘noshow’, ‘invalid’, ‘active’, ‘completed’

string

default:"0007BWpSzSwfiuSl0tR2"

Assigned User Id

string

default:"Zoom"

Appointment Address

boolean

default:"true"

true if the event is recurring otherwise false

string

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

string

default:"0TkCdp9PfvLeWKYRRvIz"

required

{
  "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"
}

400 - Bad Request

{}

401 - Unauthorized

{}

Ejemplo

curl -X POST 'https://services.leadconnectorhq.com/calendars/events/appointments' \
  -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",
  "locationId": "C2QujeCh8ZnC7al2InWR",
  "contactId": "0007BWpSzSwfiuSl0tR2",
  "startTime": "2021-06-23T03:30:00+05:30",
  "endTime": "2021-06-23T04:30:00+05:30"
}'

const response = await fetch('https://services.leadconnectorhq.com/calendars/events/appointments', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"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", "locationId": "C2QujeCh8ZnC7al2InWR", "contactId": "0007BWpSzSwfiuSl0tR2", "startTime": "2021-06-23T03:30:00+05:30", "endTime": "2021-06-23T04:30:00+05:30"}),
});
const data = await response.json();

import os, requests
response = requests.request(
    'POST',
    'https://services.leadconnectorhq.com/calendars/events/appointments',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
        'Content-Type': 'application/json',
    },
    json={"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", "locationId": "C2QujeCh8ZnC7al2InWR", "contactId": "0007BWpSzSwfiuSl0tR2", "startTime": "2021-06-23T03:30:00+05:30", "endTime": "2021-06-23T04:30:00+05:30"},
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/calendars/events/appointments');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode({'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', 'locationId': 'C2QujeCh8ZnC7al2InWR', 'contactId': '0007BWpSzSwfiuSl0tR2', 'startTime': '2021-06-23T03:30:00+05:30', 'endTime': '2021-06-23T04:30:00+05:30'}),
]);
$data = json_decode(curl_exec($ch), true);

Empezar

Scopes

Create appointment

Autorización

Body

Respuestas

Ejemplo

​Autorización

​Body

​Respuestas

​Ejemplo

Autorización

Body

Respuestas

Ejemplo