Skip to main content
POST
/
invite
curl --request POST \
  --url https://api.errorgolf.com/v1/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "emails": [
    "[email protected]"
  ]
}
'
{
  "message": "Invitations are being sent to 3 unsuspecting souls.",
  "sent": 3,
  "skipped": 0,
  "remaining": 997
}

Authorizations

​
Authorization
string
header
required

JWT token from /token endpoint

Body

application/json
​
emails
string<email>[]
required

List of email addresses for candidates brave enough to face the chaos

Required array length: 1 - 100 elements
Example:
[
  "[email protected]",
  "[email protected]",
  "[email protected]"
]

Response

Invitations accepted. The chaos begins.

​
message
string

Status message about your batch of digital torment

Example:

"Invitations are being sent to 3 unsuspecting souls. Invalid emails were mercifully spared."

​
sent
integer

Number of valid emails receiving invitations to developer purgatory

Example:

3

​
skipped
integer

Number of invalid emails that escaped the chaos

Example:

1

​
refused
string[]

Invalid emails that were rejected (probably for the best)

Example:
["invalid-email@", "not.an.email"]
​
remaining
integer

Remaining invitation slots before we cut you off for the day

Example:

997