> ## Documentation Index
> Fetch the complete documentation index at: https://docs.toolzz.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Atualizar Credencial

> Endpoint para atualizar Credencial

## Token de Acesso

<ParamField header="Authorization" type="string">
  Token de acesso ("Bearer" deve estar antes do token)
</ParamField>

## Descrição do Body

<ParamField path="id" type="string" required="true">
  O ID da Credencial deve ser um UUID válido
</ParamField>

<ParamField body="name" type="string" required="true">
  Nome da credencial
</ParamField>

<ParamField body="userId" type="string" required="true">
  ID do usuário
</ParamField>

<ParamField body="unityId" type="string" required="true">
  ID da unidade
</ParamField>

<ParamField body="integrationId" type="string" required="true">
  ID da integração
</ParamField>

<ParamField body="secretId" type="string" required="true">
  ID secreto
</ParamField>

<ParamField body="status" type="boolean" required="true">
  Status da credencial
</ParamField>

<Expandable title="Payload">
  <ResponseField name="integrationId" type="string" required>
    Identificador único da integração.
  </ResponseField>

  <ResponseField name="name" type="string" required>
    Nome da instância de integração.
  </ResponseField>

  <ResponseField name="secretId" type="string" required>
    ID secreto associado à integração.
  </ResponseField>

  <ResponseField name="status" type="boolean" required>
    Indica se a integração está ativa.
  </ResponseField>

  <ResponseField name="unityId" type="string" required>
    ID da unidade onde a integração está associada.
  </ResponseField>

  <ResponseField name="userId" type="string" required>
    ID do usuário que possui ou criou a integração.
  </ResponseField>

  <ResponseField name="virtualKey" type="string" required>
    Chave virtual da instância de integração.
  </ResponseField>
</Expandable>

## Descrição da Resposta

Abaixo você verá a descrição da resposta da credencial

<ResponseField name="message" type="string" required>
  Mensagem indicando o resultado da operação.
</ResponseField>

<ResponseField name="id" type="string" required>
  Identificador único da credencial.
</ResponseField>

<ResponseField name="name" type="string" required>
  Nome da credencial.
</ResponseField>

<ResponseField name="userId" type="string" required>
  ID do usuário associado à credencial.
</ResponseField>

<ResponseField name="unityId" type="string" required>
  ID da unidade associada à credencial.
</ResponseField>

<ResponseField name="integrationId" type="string" required>
  Identificador único da integração.
</ResponseField>

<ResponseField name="secretId" type="string" required>
  ID secreto associado à credencial.
</ResponseField>

<ResponseField name="status" type="boolean" required>
  Indica se a credencial está ativa.
</ResponseField>

<ResponseField name="virtualKey" type="string" required>
  Chave virtual da credencial.
</ResponseField>

<ResponseField name="credentials" type="object">
  Detalhes ou parâmetros adicionais da credencial.
</ResponseField>

<ResponseField name="createdAt" type="string" required>
  Data/hora de criação da credencial.
</ResponseField>

<ResponseField name="updatedAt" type="string" required>
  Data/hora da última atualização da credencial.
</ResponseField>

<ResponseField name="integration" type="object" required>
  <Expandable title="properties">
    <ResponseField name="id" type="string" required>
      Identificador único da integração.
    </ResponseField>

    <ResponseField name="name" type="string" required>
      Nome da integração.
    </ResponseField>

    <ResponseField name="iconId" type="string" required>
      ID do ícone associado à integração.
    </ResponseField>

    <ResponseField name="type" type="string" required>
      Tipo da integração.
    </ResponseField>

    <ResponseField name="status" type="boolean" required>
      Indica se a integração está ativa.
    </ResponseField>

    <ResponseField name="validationEndpoint" type="string">
      URL do endpoint de validação da integração.
    </ResponseField>

    <ResponseField name="slug" type="string" required>
      Slug da integração.
    </ResponseField>

    <ResponseField name="form" type="array" required>
      <Expandable title="properties">
        <ResponseField name="name" type="string" required>
          Nome do campo do formulário.
        </ResponseField>

        <ResponseField name="type" type="string" required>
          Tipo do campo do formulário.
        </ResponseField>

        <ResponseField name="label" type="string" required>
          Rótulo do campo do formulário.
        </ResponseField>

        <ResponseField name="maxLenght" type="integer" required>
          Tamanho máximo do campo do formulário.
        </ResponseField>

        <ResponseField name="required" type="boolean" required>
          Indica se o campo é obrigatório.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="createdAt" type="string" required>
      Data/hora de criação da integração.
    </ResponseField>

    <ResponseField name="updatedAt" type="string">
      Data/hora da última atualização da integração.
    </ResponseField>

    <ResponseField name="icon" type="object" required>
      <Expandable title="properties">
        <ResponseField name="id" type="string" required>
          Identificador único do ícone.
        </ResponseField>

        <ResponseField name="createdAt" type="string" required>
          Data/hora de criação do ícone.
        </ResponseField>

        <ResponseField name="updatedAt" type="string">
          Data/hora da última atualização do ícone.
        </ResponseField>

        <ResponseField name="institutionId" type="string" required>
          ID da instituição associada ao ícone.
        </ResponseField>

        <ResponseField name="type" type="string" required>
          Tipo do ícone.
        </ResponseField>

        <ResponseField name="fileName" type="string" required>
          Nome do arquivo associado ao ícone.
        </ResponseField>

        <ResponseField name="internalStorageUrl" type="string" required>
          URL de armazenamento interno do ícone.
        </ResponseField>

        <ResponseField name="url" type="string" required>
          URL do ícone.
        </ResponseField>

        <ResponseField name="size" type="integer" required>
          Tamanho do arquivo do ícone em bytes.
        </ResponseField>

        <ResponseField name="extension" type="string" required>
          Extensão do arquivo do ícone.
        </ResponseField>

        <ResponseField name="maskName" type="string" required>
          Nome da máscara associada ao ícone.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>