v2 - Team Invites

Create Invite

Create an invitation to join the team.

Requires MEMBERS_INVITE permission. Cannot invite someone who is already a member. A repeat invite to the same address replaces the pending one (no 409).

post/v2/teams/{team_id}/invites

Request

  • Base URL
    https://api.jubjubapp.com (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

team_idstring required

Headers

Authorizationstring
X-JubJub-Service-Keystring
X-JubJub-Agent-Keystring
X-JubJub-Platform-Keystring
Originstring
Refererstring
X-JubJub-Trial-Tokenstring

Request body

invitee_emailstring required

Email of person to invite

rolestring

Role to assign: admin, manager, editor, publisher, reviewer, viewer

custom_permissionsstring[] nullable

Custom permission overrides

Response

Successful Response

invite_idstring required
team_idstring required
team_namestring required
team_avatar_urlstring nullable
inviter_profile_idstring nullable
inviter_emailstring nullable
inviter_namestring nullable
invitee_emailstring required
invitee_email_maskedboolean
invitee_profile_idstring nullable
is_mineboolean
is_for_youboolean
rolestring required
custom_permissionsstring[] nullable
statusstring required
created_atstring date-time required
expires_atstring date-time required
responded_atstring date-time nullable
expires_in_daysinteger
email_dispatchedboolean nullable
email_errorstring nullable
email_sent_atstring date-time nullable
invite_urlstring nullable

Changes

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