Skip to main content
POST
Message an Event's guests

Headers

Authorization
string
required

value must be Bearer <token> where <token> is api key prefixed with cal_, managed user access token, or OAuth access token

Path Parameters

uuid
string<uuid>
required

Event UUID. Accepts the canonical UUID (e.g. 018ff5cd-6dc4-7d57-bcbc-374702ca8b38) or its short-uuid (Flickr Base58) form (e.g. 1cbZYoAFoJdwqN4tixezd5).

Body

application/json
segment
enum<string>
required

Which guests receive the message: GOING (confirmed, RSVP yes), MAYBE (confirmed, RSVP maybe) or PENDING (waiting for approval).

Available options:
GOING,
MAYBE,
PENDING
subject
string
required

Email subject in plain text, up to 200 characters. HTML is refused.

body
string
required

Message in plain text, up to 5000 characters. Links are allowed as plain URLs; HTML is refused.

locationId
string

Only message guests who registered for this location of the Event.

Maximum string length: 128
checkedIn
boolean

Only message guests who checked in (true) or who did not (false). Omit to message both.

Response

status
enum<string>
required
Available options:
success,
error
Example:

"success"

data
object
required