Initial Status ALPHA
Required plan: StarterDescription #
Allows the creation of Smart Invites with recipients given an initial status other than pending
.
URL format #
{data_center_url}/v1/smart_invites
Example Request #
POST /v1/smart_invites HTTP/1.1
Host: {data_center_url}
Authorization: Bearer {API_KEY}
Content-Type: application/json; charset=utf-8
{
"method": "request",
"recipients": [
{
"email": "cronofy@example.com",
"status": "accepted"
},
{
"email": "cronofy@example.org"
}
],
"smart_invite_id": "your-unique-id-for-invite",
"callback_url": "https://yourapp.example.com/cronofy/smart_invite/notifications",
"event": {
"summary": "Board meeting",
"description": "Discuss plans for the next quarter.",
"start": "2017-10-05T09:30:00Z",
"end": "2017-10-05T10:00:00Z",
"tzid": "Europe/London",
"location": {
"description": "Board room"
}
},
"organizer": {
"name": "Smart invite application"
}
}
Example Response #
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"recipients": [
{
"email": "cronofy@example.com",
"status": "accepted"
},
{
"email": "cronofy@example.org",
"status": "pending"
}
],
"smart_invite_id": "your-unique-id-for-invite",
"callback_url": "https://yourapp.example.com/cronofy/smart_invite/notifications",
"event": {
"summary": "Board meeting",
"description": "Discuss plans for the next quarter.",
"start": {
"time": "2017-10-05T09:30:00Z",
"tzid": "Europe/London"
},
"end": {
"time": "2017-10-05T10:00:00Z",
"tzid": "Europe/London"
},
"location": {
"description": "Board room"
}
},
"attachments": {
"icalendar": "BEGIN:VCALENDAR\nVERSION:2.0..."
}
}
Request parameters #
data_center_url required
The URL for the data center you want to communicate with. Possible choices are:
api-au.cronofy.com
- π¦πΊ Australiaapi-ca.cronofy.com
- π¨π¦ Canadaapi-de.cronofy.com
- π©πͺ Germanyapi-sg.cronofy.com
- πΈπ¬ Singaporeapi-uk.cronofy.com
- π¬π§ United Kingdomapi.cronofy.com
- πΊπΈ United States
Find out more about Cronofy's data centers.
recipients.status optional #
The initial status for the recipient as a String
, can be one of:
accepted
declined
pending
(default)tentative