Teams (v1)

Invite a team member

Invite a user to join a team. Provide either user_id or email, but not both.

post/api/v1/teams/{id}/invite_member

Request

  • Base URL: https://your-tenant.tines.com
  • URL: https://your-tenant.tines.com/api/v1/teams/{id}/invite_member
  • Auth: one of:
    • API key in header X-User-Token
    • HTTP bearer

Path parameters

idinteger required

ID of the team

Request body

emailstring

Email address of the user. Provide either email or user_id, not both

user_idinteger

ID of an existing user in the tenant. Provide either user_id or email, not both

rolestring

Which role the user should have on the team. Supports both default and custom roles

Response

Successful response

idinteger

User ID

first_namestring

User first name

last_namestring

User last name

emailstring

User email

is_adminboolean

Whether the user is an admin

created_atstring

When the user was created

last_seenstring nullable

When the user was last seen in the platform

invitation_acceptedboolean

Whether the user accepted the invitation to join the team

rolestring

The user's role on the team

Changes

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