Skip to Content
Guests

Erase a guest

Delete every RSVP for this email address in the organization, in the key's mode only, and remove the guest's name, email and answers from webhook deliveries not yet sent. Freed seats go to the waitlist, so someone may be promoted. Usage already counted this month is not refunded. This cannot be undone. Requires the `rsvps:write` scope.

POST
/v1/guests/erase

Delete every RSVP for this email address in the organization, in the key's mode only, and remove the guest's name, email and answers from webhook deliveries not yet sent. Freed seats go to the waitlist, so someone may be promoted. Usage already counted this month is not refunded. This cannot be undone.

Requires the rsvps:write scope.

Authorization

secretKey
headerAuthorizationBearer <token>

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

Request Body

application/json
  1. body
email*string

At most 320 characters. Spaces around it are removed.

Formatemail
Lengthlength <= 320

Response Body

The guest was erased.

application/json
  1. response

Result of erasing a guest across the organization.

email*string
mode*string

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

Value in"live""test"
rsvps_erased*integer

RSVPs deleted for this email address.

Example Request
curl -X POST 'https://api.whocoming.com/v1/guests/erase' \  -H 'Content-Type: application/json' \  -d '{  "email": "user@example.com"}'
Example Response
{  "email": "string",  "mode": "live",  "rsvps_erased": 0}