Campos Personalizados

Atualizar Campos Personalizados

Esse endpoint permite a atualização de campos personalizados no InHire, oferecendo flexibilidade para que cada cliente adapte o fluxo às necessidades do seu processo seletivo. Os campos personalizados podem ser associados às seguintes entidades do sistema:

REQUISITIONS – Requisições de vagas

JOBS – Vagas

TALENTS – Talentos

JOB_TALENTS – Candidaturas de talentos a vagas

Cada campo pode ser configurado com diferentes tipos, como texto, número, seleção, checkbox, data e outros atributos que definem sua obrigatoriedade, ordem e visibilidade.

Para as entidades JOBS e REQUISITIONS, é possível criar campos condicionados, onde a exibição de um campo depende da seleção de uma opção específica em outro campo. Recomendamos evitar estruturas complexas. Para casos onde seja necessário reutilizar campos com o mesmo nome, orientamos que entre em contato com o nosso time de suporte.

Além disso, cada campo pode ser marcado como obrigatório em contextos específicos, definidos pela propriedade requiredIn. Essa configuração garante que um campo seja requerido somente onde faz sentido para a operação, como por exemplo:

No modal de admissão (ADMISSION_MODAL)

No preenchimento de campos personalizados do talento (JOB_TALENT_MODAL)

Na criação/edição da vaga (JOB)

Na criação/edição da requisição (REQUISITION)

A visualização dos campos também pode ser controlada pela propriedade showIn, aplicável a entidades relacionadas ao talento.

Este endpoint suporta a atualização de múltiplos campos em uma única requisição, através do array customFields.

Apesar de possível, não é recomendado a atualização da aenditade de um campo personalizado, pois isso pode causar inconsistências no sistema.

patch/custom-data-manager/custom-fields

Request

  • Base URL: https://api.inhire.app
  • URL: https://api.inhire.app/custom-data-manager/custom-fields
  • Auth: HTTP bearer

Headers

X-Tenantstring required

Multi-tenant identifier. Required on every request. This determines which tenant's data the request operates on. Maps to the DynamoDB partition key (tenantId).

Request body

Response

OK

namestring

Nome legível do recurso.

requiredboolean

Indica se o campo é obrigatório.

type'number' | 'text' | 'textarea' | 'select' | 'checkbox' | 'date'

Tipo do recurso/valor (enum específico do contexto).

entity'JOB_TALENTS' | 'JOBS' | 'REQUISITIONS' | 'TALENTS' | 'POSITION'

Tipo de entidade à qual o recurso se aplica (JOBS, TALENTS, JOB_TALENTS, etc.).

isEditableOnstring[]

Flag booleana de domínio (ver campo equivalente nos types TS).

requiredInstring[]

Lista de telas/contextos em que o campo é obrigatório.

showInstring[]

Lista de telas/contextos em que o campo é exibido.

ordernumber

Ordem de exibição do item dentro da coleção (numérico, crescente).

status'enabled' | 'archived'

Status atual do recurso (enum específico do domínio).

idstring required

Identificador único do recurso (ULID).

Changes

No recorded changes to this operation across all 1 revision of this API.