Organizer email ALPHA

Allows Smart Invites to use a custom organizer email rather than using Cronofy’s default.

Works for both single- and multiple-recipient Smart Invites.

Purpose #

As well as enabling stronger branding of your invites, some calendar services and clients can refuse to process invites where the sender of the email does not match the organizer embedded within the event. Being able to set the organizer’s email address avoids this problem as it allows the two to be the same.

Email forwarding #

In order to function, emails sent to your custom organizer address must be forwarded to Cronofy for processing.

The forwarding address used varies by data centre as follows:

 Forwarding address
US πŸ‡ΊπŸ‡Έorganizer@invite.cronofy.com
DE πŸ‡©πŸ‡ͺorganizer@invite-de.cronofy.com

Without forwarding in place, responses such as acceptance and declines, will not reach Cronofy and so not be processed.

It is recommended that this address be specific to invites rather than a generic “no reply” address you may already have set up.

Create or Update Invite #

Description #

Create a new Smart Invite with a custom organizer email.

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-12-11T09:30:00Z",
    "end": "2019-12-11T10:00:00Z",
    "tzid": "Europe/London",
    "location": {
      "description": "Board room"
    }
  },
  "organizer": {
    "name": "My Application",
    "email": "organizer@myapplicaton.com"
  }
}

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-12-11T09:30:00Z",
      "tzid": "Europe/London"
    },
    "end": {
      "time": "2019-12-11T10:00:00Z",
      "tzid": "Europe/London"
    },
    "location": {
      "description": "Board room"
    }
  },
  "attachments": {
    "icalendar": "BEGIN:VCALENDAR\nVERSION:2.0..."
  }
}

Request parameters #

organizer.email optional  #

The email for the organizer of the Smart Invite. This is the value which will be used as the email of the organizer in the end users calendar. If omitted the default address for the Cronofy data centre will be used.

Email forwarding must be set up for the full capability of Smart Invites to function.

Search