Skip to content

Invites​

Endpoints to interact with Invites


Find Invites​

GET
/api/v2/invite

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

search

Limit to results with invites matching this string in part of the inviteGroup, email, firstName, lastName or hash

Type
string

Request Body​

application/json
JSON
"string"

Responses​

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Create a new Invite​

POST
/api/v2/invite

Creates a new invite from the POST data

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"id": "12585",
  
"inviteGroup": "Special Race Invites",
  
"types": [
  
],
  
"deleted": "0",
  
"eventId": "101985",
  
"typeId": "1095",
  
"email": "george@acme.com",
  
"firstName": "George",
  
"lastName": "Smith",
  
"linkedPromoCode": "1095",
  
"linkedStoredValueCode": "1908",
  
"hash": "924ca91f4beecbc983ee10876448711a"
}

Responses​

Playground​

Authorization
Body

Samples​


Find Invite by Id​

GET
/api/v2/invite/{id}

Returns a single invite

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Id of invite to return

Type
integer
Required
Format
"int64"

Responses​

Playground​

Authorization
Variables
Key
Value

Samples​


Powered by VitePress OpenAPI