Update Credential - Toolzz Docs

PUT

api

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

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

Show Payload

integrationId

string

required

Unique identifier for the integration.

name

string

required

Name of the integration instance.

secretId

string

required

Secret ID associated with the integration.

status

boolean

required

Indicates whether the integration is active.

unityId

string

required

Unity ID where the integration is associated.

userId

string

required

User ID who owns or created the integration.

virtualKey

string

required

Virtual key for the integration instance.

Response Description

Below you will see the description of the Credential response

message

string

required

Message indicating the operation result.

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

Show properties

string

required

Unique identifier for the integration.

name

string

required

Name of the integration.

iconId

string

required

Icon ID associated with the integration.

type

string

required

Type of the integration.

status

boolean

required

Indicates whether the integration is active.

validationEndpoint

string

Validation endpoint URL for the integration.

slug

string

required

Slug for the integration.

form

array

required

Show properties

name

string

required

Name of the form field.

type

string

required

Type of the form field.

label

string

required

Label for the form field.

maxLenght

integer

required

Maximum length for the form field.

required

boolean

required

Indicates if the field is mandatory.

createdAt

string

required

Timestamp indicating when the integration was created.

updatedAt

string

Timestamp indicating the last update for the integration.

icon

object

required

Show properties

string

required

Unique identifier for the icon.

createdAt

string

required

Timestamp indicating when the icon was created.

updatedAt

string

Timestamp indicating the last update for the icon.

institutionId

string

required

Institution ID associated with the icon.

type

string

required

Type of the icon.

fileName

string

required

Name of the file associated with the icon.

internalStorageUrl

string

required

Internal storage URL for the icon.

url

string

required

URL for the icon.

size

integer

required

Size of the icon file in bytes.

extension

string

required

File extension of the icon.

maskName

string

required

Mask name associated with the icon.

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>"
    }
  }
}

PUT

api

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

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

Show Payload

integrationId

string

required

Unique identifier for the integration.

name

string

required

Name of the integration instance.

secretId

string

required

Secret ID associated with the integration.

status

boolean

required

Indicates whether the integration is active.

unityId

string

required

Unity ID where the integration is associated.

userId

string

required

User ID who owns or created the integration.

virtualKey

string

required

Virtual key for the integration instance.

Response Description

Below you will see the description of the Credential response

message

string

required

Message indicating the operation result.

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

Show properties

string

required

Unique identifier for the integration.

name

string

required

Name of the integration.

iconId

string

required

Icon ID associated with the integration.

type

string

required

Type of the integration.

status

boolean

required

Indicates whether the integration is active.

validationEndpoint

string

Validation endpoint URL for the integration.

slug

string

required

Slug for the integration.

form

array

required

Show properties

name

string

required

Name of the form field.

type

string

required

Type of the form field.

label

string

required

Label for the form field.

maxLenght

integer

required

Maximum length for the form field.

required

boolean

required

Indicates if the field is mandatory.

createdAt

string

required

Timestamp indicating when the integration was created.

updatedAt

string

Timestamp indicating the last update for the integration.

icon

object

required

Show properties

string

required

Unique identifier for the icon.

createdAt

string

required

Timestamp indicating when the icon was created.

updatedAt

string

Timestamp indicating the last update for the icon.

institutionId

string

required

Institution ID associated with the icon.

type

string

required

Type of the icon.

fileName

string

required

Name of the file associated with the icon.

internalStorageUrl

string

required

Internal storage URL for the icon.

url

string

required

URL for the icon.

size

integer

required

Size of the icon file in bytes.

extension

string

required

File extension of the icon.

maskName

string

required

Mask name associated with the icon.

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

​Response Description

Toolzz Connect

​Body Description

​Response Description

Body Description

Response Description

Body Description

Response Description