Send invitations

This endpoint sends invitations to one or more email addresses that you provide, up to the number of invitations that you have remaining to send. It sends invitations to email addresses in the order that you provide them, so if you request invitations for more addresses than you have invitations to send, it will send invitations to the first several addresses, but not to those further down in the list.

Request

HTTP Headers
HTTP Header	Value
`Authorization`	You must provide a valid JSON Web Token to authenticate yourself to use this endpoint.

Examples

Example Request

POST /v1/invitations/send HTTP/1.1
Host: api.thefifthworld.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

{
  "emails": [
    "ish@thefifthworld.com",
    "em@thefifthworld.com"
  ]
}

Response

If you have authenticated, the endpoint responds with a 200 HTTP status and a JSON object mirroring the array of addresses that you submitted. The outcome of each invitation will appear in your messages shortly thereafter. If you have not authenticated, the endpoint responds with a 401 HTTP status.

Example

Example Response

{
  "emails": [
    "ish@thefifthworld.com",
    "em@thefifthworld.com"
  ]
}