POST
/
api
/
v2
/
member
curl --request POST \
  --url https://chat.api.toolzz.com.br/api/v2/member \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "email": "<string>",
  "access": "<string>"
}'
{
  "message": "<string>",
  "id": "<string>",
  "institutionId": "<string>",
  "unityId": "<string>",
  "userId": "<string>",
  "name": "<string>",
  "email": "<string>",
  "access": "<string>",
  "status": 123,
  "acceptedAt": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "user": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "avatar": "<string>"
  },
  "avatar": "<string>"
}

Body Description

name
string
required

The name

email
string
required

The email

access
string
required

The access level can be ADMIN | USER | MANAGER

Response Description

Below you will see the description of the member creation response

message
string
required

Message content.

id
string

Optional unique identifier.

institutionId
string

Optional ID of the associated institution.

unityId
string

Optional ID of the associated unity.

userId
string

Optional ID of the associated user.

name
string

Optional name of the individual.

email
string

Optional email address of the individual.

access
string

Optional access level.

status
number

Optional status indicator, allowed values are 0 (inactive) or 1 (active).

acceptedAt
string

Optional timestamp indicating when the request was accepted.

createdAt
string

Optional timestamp indicating when the record was created.

updatedAt
string

Optional timestamp indicating when the record was last updated.

user
object

Optional nested user object.

avatar
string

Optional URL of the avatar.

Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido através do cabeçalho de autorização (Authorization) da requisição. Além disso, a API é protegida por outras medidas de segurança para proteger os dados dos usuários.