Skip to main content

Invite member

Description

Invite a user to join a team

Request

HTTP Method: POST

Path ParameterDescription
team-idID of the team
Query ParameterDescription
emailEmail address of the user
user_idoptional ID of an existing user in the Tines tenant

user_id or email must be provided but not both.

curl -X POST \
https://<tenant-domain>/api/v1/teams/<team-id>/invite_member \
-H 'content-type: application/json' \
-H 'x-user-email: <email-address>' \
-H 'x-user-token: <api-token>'
-d '{
"email": "user@example.com"
}'

Response

A successful request will return a JSON object representing the invited user.

Field description

ParameterDescription
idUser ID.
emailUser email.
first_nameUser first name.
last_nameUser last name.
is_adminBoolean flag indicating whether user is an admin.
created_atTimestamp describing when the user was created.
last_seenTimestamp describing when the user was last seen in the platform.
invitation_acceptedBoolean flag indicating if the user accepted the invitation to join the team

Sample response

{
"id": 2,
"first_name": "First name",
"last_name": "Last name",
"email": "user@example.com",
"is_admin": false,
"created_at": "2021-04-30T09:12:40Z",
"last_seen": null,
"invitation_accepted": false
}