SPspectate
Invites

Invite someone

Emails them a link to join the team. Someone who is a member already, or has a pending invite, can't be invited again (422); an expired invite to the address is replaced. Over the plan's member limit, counting pending invites, the request fails with 403 PLAN_LIMIT_REACHED.

post/invites

Request

  • Base URL
    https://api.spectate.net/v1
  • Auth
    HTTP bearer

Request body

emailstring email required

Their email address; disposable addresses aren't accepted

role'owner' | 'manager' | 'admin' | 'member' | 'billing'

A member's role in the team: what they may do.

owner <br/> Everything, including billing and deleting the team. One per team.
manager <br/> Everything but billing and deleting the team.
admin <br/> Configure monitoring, alerting, incidents and status pages; can't manage members or API tokens.
member <br/> Read everything; manage monitors and incidents, acknowledge alerts.
billing <br/> Billing and support only.

Example request

{
  "email": "jane@example.com"
}

Response

The invite.

idstring uuid required

Invite ID

emailstring email required

The invitee's email address

role'owner' | 'manager' | 'admin' | 'member' | 'billing' required

A member's role in the team: what they may do.

owner <br/> Everything, including billing and deleting the team. One per team.
manager <br/> Everything but billing and deleting the team.
admin <br/> Configure monitoring, alerting, incidents and status pages; can't manage members or API tokens.
member <br/> Read everything; manage monitors and incidents, acknowledge alerts.
billing <br/> Billing and support only.
expiredboolean required

Whether it expired without being accepted. Expired invites don't count towards the member limit and can be sent again

expires_atstring date-time required

When it expires, 7 days after it was sent

created_atstring date-time required

When it was sent

Example response

{
  "email": "jane@example.com"
}

Changes

No recorded changes to this operation across all 1 revision of this API.