Send Email Invites - ErrorGolf Documentation

curl --request POST \ --url https://api.errorgolf.com/v1/invite \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "emails": [ "sarah.chen@example.com" ] } '

Bulk Candidate Torture Invitations

Send Error Golf challenge invitations to up to 100 unsuspecting candidates at once. Perfect for lazy hiring managers who can’t be bothered to copy-paste email addresses like some kind of prehistoric recruiter.

The process:

Submit a list of email addresses (1-100 victims)

We validate each email and remove duplicates (because even chaos needs order)

Invitations are sent asynchronously in batches of 10 (so we don’t anger the email gods)

Each candidate gets your company’s live code and a one-way ticket to developer purgatory

Rate limiting (because we’re not completely evil):

1000 invitations per company per day

Limit resets at midnight UTC (when all good developers should be sleeping)

Current usage returned so you know when to stop the madness

Email validation (surprisingly thorough):

Proper email format checking (we’re not savages)

Automatic whitespace trimming (because spaces are the devil)

Duplicate removal (nobody deserves our questions twice in one day)

Helpful error messages for when you inevitably mess up

Async processing (the waiting game):

Emails sent in background batches while you contemplate your hiring choices

Individual failures don’t stop the chaos train

Small delays between batches (even email services have feelings)

Warning: This uses your live code, so completed assessments will cost you $39 each. Budget accordingly.

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:

[
  "sarah.chen@example.com",
  "unsuspecting.dev@techcorp.com",
  "future.victim@startup.io"
]

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