Criar documento

Anexa um documento à entidade.

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.

Path Parameters

entity_name

string

required

Nome da entidade

Query Parameters

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.

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.

Body

application/json

key

string

required

Chave/Nome que será dado ao documento

value

object

required

Valor/Objeto que deve corresponder ao schema da entidade, ao qual o documento está sendo inserido

Response

200 - application/json

id

string

Identificador exclusivo para o objeto.

key

string

Chave/Nome que será dado ao documento

value

object

Valor/Objeto que deve corresponder ao schema da entidade, ao qual o documento está sendo inserido

dataEntity

string

Id da entidade, ao qual o documento está relacionado

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.