Skip to Content
RSVPs

Create an RSVP

Add a guest. Capacity and the waitlist apply. One RSVP per email per event (409 `already_registered`). Accepts `Idempotency-Key`. Requires the `rsvps:write` scope.

POST
/v1/events/{id}/rsvps

Add a guest. Capacity and the waitlist apply. One RSVP per email per event (409 already_registered). Accepts Idempotency-Key.

Requires the rsvps:write scope.

Authorization

secretKey
headerAuthorizationBearer <token>

A secret key: wc_live_... or wc_test_.... Keep it on your server.

Path Parameters

id*string
Match^evt_[0-9A-Za-z]{6,64}$

Header Parameters

idempotency-key?string

Send a unique value (a UUID works) to make retries safe. A replay within 24 hours returns the first response; the same key with a different body is a 409 idempotency_conflict.

Length1 <= length <= 255

Request Body

application/json
  1. body

answers are checked against the event's fields: each value must match its question's type (text, one of the options, a number, true or false), and a key the event has no question for is refused. Unlike the public RSVP form, a required question may be left out, so you can import guests who never saw the form.

name*string
Length1 <= length <= 200
email*string

At most 320 characters. Spaces around it are removed.

Formatemail
Lengthlength <= 320
guests?integer

Extra guests, up to the event's max_guests. Defaults to 0.

Range0 <= value <= 100
answers?

Answers to the event's custom fields, keyed by field key. Text up to 5000 characters (500 for a short-answer question), a number, true or false. At most 100 keys and 100000 characters in all as JSON.

Propertiesproperties <= 100
status?string

Defaults to going. A full event with a waitlist answers waitlisted; without one, 409 capacity_reached.

Value in"going""not_going"

Response Body

The RSVP was created.

application/json
  1. response
id*string
Match^rsvp_[0-9A-Za-z]{6,64}$
event_id*string
Match^evt_[0-9A-Za-z]{6,64}$
mode*string

live or test. Always the mode of the API key that made the request.

Value in"live""test"
name*|

null when locked is true, or after the retention period.

email*|

null when locked is true, or after the retention period.

status*string

waitlisted is set by WhoComing when the event is full; it cannot be requested directly.

Value in"going""not_going""waitlisted""cancelled"
guests*integer

Extra guests (plus-ones).

answers*|

Answers to the event's custom fields, keyed by field key.

source*string

Where the RSVP came from. New values may be added.

Value in"embed""page""api""dashboard"
locked*boolean

True when the RSVP arrived after a Free organization reached its monthly limit. Guest details are hidden until the organization upgrades or the next month starts.

checked_in_at*|

ISO 8601 with a UTC offset.

Formatdate-time
created_at*string

ISO 8601 with a UTC offset.

Formatdate-time
updated_at*string

ISO 8601 with a UTC offset.

Formatdate-time
Example Request
curl -X POST 'https://api.whocoming.com/v1/events/string/rsvps' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "email": "user@example.com"}'
Example Response
{  "id": "string",  "event_id": "string",  "mode": "live",  "name": "string",  "email": "string",  "status": "going",  "guests": 0,  "answers": {    "property1": "string",    "property2": "string"  },  "source": "embed",  "locked": true,  "checked_in_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}