PUT
/
api
/
v1
/
credential
/
{id}
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>"
    }
  }
}

​
Body Description

​
id
string
required

The ID of Credential must be a valid UUID

​
name
string
required

The name

​
userId
string
required

The userId

​
unityId
string
required

The unityId

​
integrationId
string
required

The integrationId

​
secretId
string
required

The secretId

​
status
boolean
required

The status

​
Response Description

Below you will see the description of the Credential response

​
message
string
required

Message indicating the operation result.

​
id
string
required

Unique identifier for the credential.

​
name
string
required

Name of the credential.

​
userId
string
required

ID of the user associated with the credential.

​
unityId
string
required

ID of the unity associated with the credential.

​
integrationId
string
required

Unique identifier for the integration.

​
secretId
string
required

Secret ID associated with the credential.

​
status
boolean
required

Indicates whether the credential is active.

​
virtualKey
string
required

Virtual key for the credential.

​
credentials
object

Additional details or parameters for the credential.

​
createdAt
string
required

Timestamp indicating when the credential was created.

​
updatedAt
string
required

Timestamp indicating the last update for the credential.

​
integration
object
required