Team

Email an invitation to join the account

Invites a person by email with the role member (default) or admin, and sends the same invitation email as the app; the link expires in 7 days. Same rules as Settings > Team: owners and admins may invite, only the owner may invite an admin, the inviter must have confirmed their email address, the team (members plus open invitations) is limited to the seat limit, the same address can be invited again only after a minute and an account can send 20 invitations a day. Inviting an address with an open invitation replaces it. Requires the write scope and an idempotency key: a retry with the same key returns the first invitation without emailing again. Confirm the address with the user first.

post/team/invitations

Request

  • Base URL: https://adslighthouse.com/api/v1
  • URL: https://adslighthouse.com/api/v1/team/invitations
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

A unique value you choose for this request, such as a UUID. Repeating the same key returns the first result instead of starting paid work again.

Request body

emailstring required

The address to invite.

role'member' | 'admin'

Response

Email an invitation to join the account

createdboolean required
request_idstring

Changes

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