Create or Update Invite BETA

Description #

Create a new Smart Invite for a recipient.

URL format #

api.cronofy.com/v1/smart_invites

Example Request #

POST /v1/smart_invites HTTP/1.1
Host: api.cronofy.com
Authorization: Bearer {API_KEY}
Content-Type: application/json; charset=utf-8

{
  "method": "request",
  "recipient": {
    "email": "cronofy@example.com"
  },
  "smart_invite_id": "your-unique-identifier-for-invite",
  "callback_url": "https://example.yourapp.com/cronofy/smart_invite/notifications",
  "event": {
    "summary": "Board meeting",
    "description": "Discuss plans for the next quarter.",
    "start": "2019-11-21T09:30:00Z",
    "end": "2019-11-21T10: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

{
  "recipient": {
    "email": "cronofy@example.com",
    "status": "pending"
  },
  "smart_invite_id": "your-unique-identifier-for-invite",
  "callback_url": "https://example.yourapp.com/cronofy/smart_invite/notifications",
  "event": {
    "summary": "Board meeting",
    "description": "Discuss plans for the next quarter.",
    "start": {
      "time": "2019-11-21T09:30:00Z",
      "tzid": "Europe/London"
    },
    "end": {
      "time": "2019-11-21T10:00:00Z",
      "tzid": "Europe/London"
    },
    "location": {
      "description": "Board room"
    }
  },
  "attachments": {
    "icalendar": "BEGIN:VCALENDAR\nVERSION:2.0..."
  }
}

Request parameters #

API_KEY required  #

The client_secret of the client creating the event.

smart_invite_id required  #

An identifier for the event within your application. Is used along with the recipient.email to uniquely identify the Smart Invite.

callback_url optional  #

The URL within your application you want Cronofy to send notifications to about user interactions with the Smart Invite.

event required  #

An object with the details of the event you wish to wish to invite the recipient to. Details of what parameters this object can hold can be found in the create or update event documentation.

Please note that event.attendees is not supported for Smart Invites.

recipient.email required  #

The email address you are going to send the Smart Invite to.

method optional  #

The method to use when creating the invite, this defaults to request

  • request request a response from invited emails.
  • cancel cancel the invitation.
organizer.name optional  #

The display name for the organizer of the Smart Invite. This is the value which will appear as the name of the organizer in the end users calendar. If omitted the name of the application will be used in its place.

Response parameters #

recipient.email  #

The email address of the recipient for the Smart Invite.

recipient.status  #

The current status of the recipient. Can be one of:

  • pending have not received any response from the recipient
  • accepted the recipient has accepted the invitation
  • tentative the recipient has tentatively accepted the invitation
  • declined the recipient has declined the invitation
smart_invite_id  #

The identifier for the event within your application.

callback_url  #

The URL within your application that Cronofy will send notifications to about user interactions with the Smart Invite.

event  #

The details of the event.

attachments  #

Attachments to add to the multipart email being sent to the recipient.

attachments.icalendar  #

The iCalendar representation of the event to to sent to the user.

Search