POST
/
v1
/
operators
curl --request POST \
  --url https://api.base39.io/v1/operators \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "document": "<string>",
  "name": "<string>",
  "email": "<string>",
  "username": "<string>",
  "metadata": {}
}'
{
  "id": "oprt_5f92f01728e009f403d8502e",
  "document": "<string>",
  "name": "<string>",
  "email": "<string>",
  "username": "<string>",
  "permissions": {
    "url": "/v1/permissions?operator=oprt_62d9889bd3985729e5a048ef&starting_after=perm_62d9889bd3985729e5a048ef",
    "hasMore": true,
    "data": [
      {
        "id": "perm_62d9889bd3985729e5a048ef",
        "company": "comp_62d9889bd3985729e5a048ef",
        "roles": [
          "approver"
        ],
        "createdAt": "2023-08-25T22:38:41.134Z",
        "updatedAt": "2023-08-25T22:38:41.134Z",
        "deleted": false,
        "createdBy": {
          "clientId": "client_identifier",
          "externalClientId": "<string>",
          "app": "backoffice"
        },
        "updatedBy": {
          "clientId": "client_identifier",
          "externalClientId": "<string>",
          "app": "backoffice"
        }
      }
    ]
  },
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z",
  "deleted": false,
  "createdBy": {
    "clientId": "client_identifier",
    "externalClientId": "<string>",
    "app": "backoffice"
  },
  "updatedBy": {
    "clientId": "client_identifier",
    "externalClientId": "<string>",
    "app": "backoffice"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

Chave única de idempotência para evitar duplicação de requisições.

​
base39-external-client-id
string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

Query Parameters

​
expand
string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

​
fields
string

Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

Body

application/json

Criar um operador

​
document
string
required

O documento do operador sem pontuação.

​
name
string
required

O nome completo do operador ou o nome da empresa.

​
email
string
required

O endereço de e-mail do operador.

​
username
string
required

Nome de usuário para login. Pode ser qualquer valor único.

​
metadata
object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

Response

201 - application/json
Retorna o objeto `Operator` se a criação for bem-sucedida; caso contrário, um erro.

Este objeto representa um operador.

​
id
string

Identificador exclusivo para o objeto.

Example:

"oprt_5f92f01728e009f403d8502e"

​
document
string

O documento do operador sem pontuação.

​
name
string

O nome completo do operador ou o nome da empresa.

​
email
string

O endereço de e-mail do operador.

​
username
string

Nome de usuário para login. Pode ser qualquer valor único.

​
permissions
object
​
metadata
object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

​
createdAt
string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

​
updatedAt
string

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

​
deleted
boolean
default:false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Example:

false

​
createdBy
object
​
updatedBy
object