Skip to main content
PUT
/
internal
/
checkbook
/
client-credentials
/
{id}
Update Checkbook client credentials
curl --request PUT \
  --url https://api.platform.dakota.xyz/internal/checkbook/client-credentials/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "publishable_key": "d9cXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "secret_key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "base_url": "https://api.checkbook.io",
  "is_active": true
}
'
{
  "id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
  "client_id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
  "publishable_key": "d9cXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "base_url": "https://api.checkbook.io",
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

The Checkbook client credentials ID

Body

application/json

Request to update Checkbook client credentials

​
publishable_key
string

Checkbook publishable API key

Example:

"d9cXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

​
secret_key
string

Checkbook secret API key (will be encrypted before storage)

Example:

"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

​
base_url
string

Checkbook API base URL

Example:

"https://api.checkbook.io"

​
is_active
boolean

Whether these credentials are active

Example:

true

Response

Checkbook client credentials updated successfully

Checkbook client credentials for multi-root-user support

​
id
string
required

KSUID is a 27-character globally unique ID that combines a timestamp with a random component. Used for all entity identifiers in the Dakota platform.

Required string length: 27
Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

​
client_id
string
required

KSUID is a 27-character globally unique ID that combines a timestamp with a random component. Used for all entity identifiers in the Dakota platform.

Required string length: 27
Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

​
publishable_key
string
required

Checkbook publishable API key

Example:

"d9cXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

​
base_url
string
required

Checkbook API base URL

Example:

"https://api.checkbook.io"

​
is_active
boolean
required

Whether these credentials are active

Example:

true

​
created_at
string<date-time>
required

When the credentials were created

​
updated_at
string<date-time>
required

When the credentials were last updated