POST
/
v1
/
operators

Authorizations

Authorization
string
headerrequired

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.

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

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

Este objeto representa um operador.

id
string

Identificador exclusivo para o objeto.

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

updatedAt
string

Data de alteração do objeto

deleted
boolean
default: false

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