Skip to main content
PUT
/
events
/
{event_id}
/
invites
/
{invite_id}
Update Invite Status
curl --request PUT \
  --url https://api.securegate.ai/events/{event_id}/invites/{invite_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "status": "pending"
}'
{
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "<string>",
  "country_code": "1",
  "mobile_number": "<string>",
  "authentication_method": "QR Code",
  "id": "<string>",
  "event_id": "<string>",
  "session_code": "<string>",
  "image": "<string>",
  "session_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "last_seen": "2023-11-07T05:31:56Z",
  "onyxplus_id": "<string>",
  "ticket_id": "<string>",
  "status": "pending"
}
This endpoint allows you to change the status of an invitation. Use it to manually update an invitation’s status when needed, such as marking it as accepted or rejected. What it does:
  • Changes the status of a specific invitation
  • Updates the invitation record with the new status
  • Records the time of the status change
When to use it:
  • When manually updating an invitation based on an RSVP
  • If an attendee contacts you directly to accept or decline
  • When you need to override an invitation status
  • For administrative management of invitations

Path Parameters

ParameterTypeRequiredDescription
event_idstringYesThe unique identifier of the event
invite_idstringYesThe unique identifier of the invite to update

Request Body

The request body should include the new status for the invite:
{
  "status": "accepted"
}
FieldTypeRequiredDescription
statusstringYesThe new status of the invite. Options include: “pending”, “sent”, “accepted”, “rejected”

Response

The API returns the updated invite object with all its details:
{
  "id": "invite-123",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "country_code": "1",
  "mobile_number": "5551234567",
  "authentication_method": "QR Code",
  "event_id": "event-456",
  "session_code": "ABC123",
  "session_id": "session-789",
  "image": "https://example.com/profile-photos/john-doe.jpg",
  "status": "accepted",
  "created_at": "2023-02-28T12:00:00Z",
  "updated_at": "2023-03-01T09:30:00Z",
  "last_seen": null,
  "onyxplus_id": "onyx-123",
  "ticket_id": "ticket-456"
}
Status meanings:
  • pending: The invitation has been created but not sent
  • sent: The invitation has been sent but not yet responded to
  • accepted: The invitee has accepted the invitation
  • rejected: The invitee has declined the invitation
Note: The updated_at field will automatically be set to the current time when you change the status.

Authorizations

x-api-key
string
header
required

API key authentication. Add your API key as the value of the 'x-api-key' header.

Path Parameters

event_id
string
required
invite_id
string
required

Body

application/json
status
enum<string>
required
Available options:
pending,
sent,
accepted,
rejected

Response

Successful Response

first_name
string
required
last_name
string
required
email
string
required
country_code
enum<string>
required
Available options:
1,
44,
1,
61,
91,
345
mobile_number
string
required
authentication_method
enum<string>
required
Available options:
QR Code,
Biometric,
Both
id
string
required
event_id
string
required
session_code
string
required
session_id
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
image
string | null
last_seen
string<date-time> | null
onyxplus_id
string | null
ticket_id
string | null
status
enum<string>
Available options:
pending,
sent,
accepted,
rejected