Skip to content

Update a checkout profile​

PUT
/products/checkout_profiles/{checkout_profile_id}

Authorizations​

bearerToken|siteContext
bearerToken

Personal access token tied to a user account. Requires the X-Nimbu-Site header to scope requests.

TypeHTTP (bearer)
+
siteContext

Identifier of the site context when authenticating with a personal access token.

TypeAPI Key (header: X-Nimbu-Site)
or
siteToken

Site-scoped API token that already encodes the site context.

TypeHTTP (bearer)

Parameters​

Path Parameters

checkout_profile_id*

Checkout profile slug or ID

Typestring
Required

Request Body​

application/json
JSON
{
"name": "string",
"slug": "string",
"customizations": [
{
"name": "string",
"label": "string",
"hint": "string",
"type": "string",
"required": true,
"localized": true,
"select_options": [
{
"id": "string",
"name": "string",
"label": "string",
"slug": "string",
"position": 0
}
]
}
]
}

Responses​

checkout profile updated

application/json
JSON
{
"id": "string",
"url": "string",
"slug": "string",
"name": "string",
"private_fields": [
"string"
],
"customizations": [
{
"id": "string",
"name": "string",
"label": "string",
"hint": "string",
"type": "string",
"required": true,
"localized": true,
"encrypted": true,
"auto_expand": true,
"select_options": [
{
"id": "string",
"name": "string",
"label": "string",
"slug": "string",
"position": 0
}
],
"private_storage": true,
"text_formatting": "string"
}
],
"created_at": "string",
"updated_at": "string"
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​