Teams | Truvera Documentation portal

Accept invitation to be a team member

POSThttps://api-testnet.truvera.io/teams/accept-member-invite

Body

Accept invitation token

accept_invitation_token*string

The token received in the mail

Response

Invitation has been accepted

Body

id*integer

The team ID

team_owner_idinteger

The team owner ID

namenullable string

The team name

Request

const response = await fetch('https://api-testnet.truvera.io/teams/accept-member-invite', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "accept_invitation_token": "text"
    }),
});
const data = await response.json();

Response

{
  "id": 0,
  "team_owner_id": 0,
  "name": "text"
}

Send email invitations to a list of emails

POSThttps://api-testnet.truvera.io/teams/{id}/invite

Path parameters

id*integer

An ID

Body

Emails array

emails*array

The emails list

Response

Invitations have been sent

Body

codeinteger

Request

const response = await fetch('https://api-testnet.truvera.io/teams/{id}/invite', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "emails": []
    }),
});
const data = await response.json();

Response

{
  "code": 0
}

Update a Team

PATCHhttps://api-testnet.truvera.io/teams/{id}

Path parameters

id*integer

An ID

Body

Team JSON object that will be applied

name*string

The new team name

Response

Team has been updated

Body

id*integer

The team ID

team_owner_idinteger

The team owner ID

namenullable string

The team name

Request

const response = await fetch('https://api-testnet.truvera.io/teams/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "id": 0,
  "team_owner_id": 0,
  "name": "text"
}

List all Team Member Invitations

GEThttps://api-testnet.truvera.io/teams/{id}/invitations

Path parameters

id*integer

An ID

Query parameters

Response

A paged array of invitations

Body

id*integer

The team member invitation ID

email*string

The team member invitation email

statusenum

The team member invitation status

pendingacceptedcanceled

Request

const response = await fetch('https://api-testnet.truvera.io/teams/{id}/invitations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": 0,
    "email": "text",
    "status": "pending"
  }
]

Resend the invitation email

POSThttps://api-testnet.truvera.io/teams/{id}/invitations/{invitation_id}/resend

Path parameters

id*integer

An ID

invitation_id*string

An ID

Response

The invitation has been resent

Body

codeinteger

Request

const response = await fetch('https://api-testnet.truvera.io/teams/{id}/invitations/{invitation_id}/resend', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "code": 0
}

Cancel the current invitation

POSThttps://api-testnet.truvera.io/teams/{id}/invitations/{invitation_id}/cancel

Path parameters

id*integer

An ID

invitation_id*string

An ID

Response

The invitation has been canceled.

Body

codeinteger

Request

const response = await fetch('https://api-testnet.truvera.io/teams/{id}/invitations/{invitation_id}/cancel', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "code": 0
}

List all Team Members

GEThttps://api-testnet.truvera.io/teams/{id}/members

Path parameters

id*integer

An ID

Query parameters

Response

A paged array of team members

Body

id*integer

The team member ID

name*string

The team member name

emailstring

The team member email

imagestring

The team member image

roleenum

The team member role

memberadministratorowner

Request

const response = await fetch('https://api-testnet.truvera.io/teams/{id}/members', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": 0,
    "name": "text",
    "email": "text",
    "image": "text",
    "role": "member"
  }
]

Deletes a single team member

DELETEhttps://api-testnet.truvera.io/teams/{id}/members/{user_id}

Path parameters

id*integer

An ID

user_id*string

An ID

Response

Team member deleted

Request

const response = await fetch('https://api-testnet.truvera.io/teams/{id}/members/{user_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "status": 0,
  "type": "text",
  "message": "text"
}

Update a team member

PATCHhttps://api-testnet.truvera.io/teams/{id}/members/{user_id}

Path parameters

id*string

An ID

user_id*string

An ID

Body

Team member JSON object that will be applied

role*enum

The new team member role

memberadministrator

Response

Team member updated

Body

id*integer

The team member ID

name*string

The team member name

emailstring

The team member email

imagestring

The team member image

roleenum

The team member role

memberadministratorowner

Request

const response = await fetch('https://api-testnet.truvera.io/teams/{id}/members/{user_id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "role": "member"
    }),
});
const data = await response.json();

Response

{
  "id": 0,
  "name": "text",
  "email": "text",
  "image": "text",
  "role": "member"
}