POST
/
v1
/
operators
/
{operator}
curl --request POST \
  --url https://api.base39.io/v1/operators/{operator} \
  --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
      }
    ]
  },
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z",
  "deleted": false
}

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.

Path Parameters

​
operator
string
required

ID do operador

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[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Body

application/json

Este objeto representa um operador.

Response

200 - application/json

Retorna o objeto Operator se a atualização for bem-sucedida. Retorna um erro se os parâmetros de atualização forem inválidos.

Este objeto representa um operador.