Members

Invites a new member to the team via email, with specific permissions.

Invites a new member to the team via email, with specific permissions. Team admin permissions are required.

post/api/v1/members

Request

  • Base URL: https://uniform.app
  • URL: https://uniform.app/api/v1/members
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Request body

isAdminboolean required

If true, the API key will be a team admin and all other roles and permissions are irrelevant

emailstring email required

The email address of the person to invite

teamIdstring required
sendEmailboolean required

If true, an email will be sent to the person. If false, the invitation link returned from the request must be shared with the user via some other channel.

namestring required

The name of the person to invite. NOTE: only used for the email, does not set a name for the account

Response

Invitation sent

invitationUrlstring required

The URL to send to the person to accept the invitation

Changes

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