RErebrandly
Invites

Create Account Invite

Create a new invite to add a teammate.

Requires: collaboration.teammates feature flag.

post/account/invites

Request

  • Base URL
    https://api.rebrandly.com/v1
  • URL
    https://api.rebrandly.com/v1/account/invites
  • Auth
    API key in header apikey

Headers

apikeystring required

API key for authentication

Request body

emailstring email required

Email address to invite

role'admin' | 'user' | 'guest' | 'viewer'

Role to grant (default is user)

workspacesstring[]

Workspace IDs to grant access to

Response

Created invite

idstring required

Invite public ID

emailstring email required

Invitee's email address

role'owner' | 'admin' | 'user' | 'guest' | 'viewer'

Role to be granted upon acceptance

status'pending' | 'accepted' | 'expired' required

Invite status

createdAtstring date-time
expiresAtstring date-time

When the invite expires

Changes

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