PUT
/
api
/
v1
/
credential
/
{id}
Atualizar Credencial
curl --request PUT \
  --url https://chat.api.toolzz.com.br/api/v1/credential/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "userId": "<string>",
  "unityId": "<string>",
  "integrationId": "<string>",
  "secretId": "<string>",
  "status": true
}'
{
  "message": "<string>",
  "id": "<string>",
  "name": "<string>",
  "userId": "<string>",
  "unityId": "<string>",
  "integrationId": "<string>",
  "secretId": "<string>",
  "status": true,
  "virtualKey": "<string>",
  "credentials": {},
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "integration": {
    "id": "<string>",
    "name": "<string>",
    "iconId": "<string>",
    "type": "<string>",
    "status": true,
    "validationEndpoint": "<string>",
    "slug": "<string>",
    "form": [
      {
        "name": "<string>",
        "type": "<string>",
        "label": "<string>",
        "maxLenght": 123,
        "required": true
      }
    ],
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "icon": {
      "id": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "institutionId": "<string>",
      "type": "<string>",
      "fileName": "<string>",
      "internalStorageUrl": "<string>",
      "url": "<string>",
      "size": 123,
      "extension": "<string>",
      "maskName": "<string>"
    }
  }
}

Descrição do Body

id
string
required
O ID da Credencial deve ser um UUID válido
name
string
required
Nome da credencial
userId
string
required
ID do usuário
unityId
string
required
ID da unidade
integrationId
string
required
ID da integração
secretId
string
required
ID secreto
status
boolean
required
Status da credencial

Descrição da Resposta

Abaixo você verá a descrição da resposta da credencial
message
string
required
Mensagem indicando o resultado da operação.
id
string
required
Identificador único da credencial.
name
string
required
Nome da credencial.
userId
string
required
ID do usuário associado à credencial.
unityId
string
required
ID da unidade associada à credencial.
integrationId
string
required
Identificador único da integração.
secretId
string
required
ID secreto associado à credencial.
status
boolean
required
Indica se a credencial está ativa.
virtualKey
string
required
Chave virtual da credencial.
credentials
object
Detalhes ou parâmetros adicionais da credencial.
createdAt
string
required
Data/hora de criação da credencial.
updatedAt
string
required
Data/hora da última atualização da credencial.
integration
object
required