Scheduling
Use this method to schedule a meeting
POST
https://app.zencal.io/api/v1/schedule
Headers
Name | Type | Description |
---|---|---|
X-Zencal-Api-Key* | String | Zencal Api key |
Accept* | String | application/json |
Conten-Type* | String | application/json |
Request Body
Name | Type | Description |
---|---|---|
dates* | Array | Array of objects. Each date need to have "start" and "username" fields. Field "start" is a UTC date in ISO 8601 format. Field "username" is a host's username e.g. [ { "start":"2023-05-13T10:00:00.000Z", "username":"joe-smith" } ], |
email* | String | Participant's email |
lang* | String | Language for system messages. Available values: en, pl |
name* | String | Participant's name |
phone | String | Participant's phone number. It can be required as it's defined in meeting topic advanced settings. |
place* | String | Place of the meeting. Available values: "offline" "phone-call" "google-meet" "teamsForBusiness" "skypeForBusiness" "skypeForConsumer" "zoom" "webex" The place must match the account integration settings. |
meetingTopic* | String | Meeting topic's uuid |
team | String | Team's uuid. Required if it's a team meeting |
timezone* | String | Participant's timezone |
gateway | String | Payment gateway code. Available options: "stripe" "p24" "payu" "paypal" "tpay" It's required if meeting topic is defined as paid. |
note | String | Note left by participant |
invoiceName | String | Name for the invoice |
invoiceAddress | String | Address for the invoice |
invoicePostalCode | String | Postal code for the invoice |
invoiceCity | String | City for the invoice |
invoiceTaxNumber | String | Tax number for the invoice |
discount | String | Discount code |
priceVariant | String | Price variant uuid |
form | Object | Form answers |
metadata | Object | In this field you can store any information you need |
Use this method to calculate available dates
POST
https://app.zencal.io/api/v1/calculate-schedule
Request Body
Name | Type | Description |
---|---|---|
username* | String | Host's username from profile |
meetingTopic* | String | Meeting topic's uuid |
timezone* | String | Participant's timezone |
offset* | Number | Number of days added to the current date to determine the first date in the schedule. Must be a multiple of 7 Minimum: 0 It's ignored when month is defined. |
month | Number | Number of the month. The first month is January of the current year. For example, the value 5 means May of this year. The value 14 means February of the following year. Minimum: 1 |
team | String | Team's uuid. Required if it is meeting topic for the team |
Last updated