Update Configuration Record

1 min

PUT

https://api.upstartcommerce.com/v1/tenants/cfg/records/{recordId}

This endpoint update cfg record.

Authorized permissions:

tenant.cfg.modify

Path Parameters

recordIdstringrequired
Description
Unique identifier for a given record.

Header Parameters

x-upstart-tenantstringrequired
Description
Tenant identifier associated with the site this call is for.

Body Parameters

bodyUpdateCfgRecordrequired
Example
```
{
  "templateId": "payment-cybersource",
  "siteIds": [
    "us-west-store",
    "us-east-store",
    "us-central-store"
  ],
  "tags": [
    "production",
    "payment-gateway",
    "us-region",
    "pci-sensitive",
    "verified"
  ],
  "name": "Cybersource US Production Credentials - Updated",
  "data": {
    "merchantId": "acme_us_prod",
    "apiKey": "sk_live_NEW_KEY_rotated_2025_Q1_abc123xyz789",
    "apiUrl": "https://api.cybersource.com",
    "currency": "USD"
  },
  "enabled": true,
  "accessControl": {
    "read": true,
    "modify": false
  }
}
```
Description
The configuration record values to update.
- templateIdstringrequired
  Example
  payment-cybersource
  Description
  The template ID this record is based on. While technically updatable, changing template IDs is dangerous as it changes the expected schema. In most cases, provide the current templateId to maintain schema consistency. Create a new record if you need a different template.
- siteIdsstring[]
  Example
```
[
  "us-west-store",
  "us-east-store",
  "us-central-store"
]
```
  Description
  Updated list of site IDs this configuration applies to. Replaces the previous siteIds array entirely. Set to empty array for tenant-wide configuration. Use this to expand/restrict the scope of the configuration to different sites (e.g., add new stores, remove old ones).
- tagsstring[]
  Example
```
[
  "production",
  "payment-gateway",
  "pci-sensitive",
  "us-region",
  "verified"
]
```
  Description
  Updated tags for the record. Replaces the previous tags array entirely. Modify to change environment classification, add security labels, or update categorization as the record's purpose evolves (e.g., promoting from 'staging' to 'production').
- namestringrequired
  Example
  Cybersource US Production Credentials - Updated Q1 2025
  Description
  Updated human-readable name for the record. Use to clarify purpose, reflect ownership changes, or improve naming conventions. Should remain descriptive and unique within the tenant.
- dataobjectrequired
  Example
```
{
  "merchantId": "acme_us_prod",
  "apiKey": "sk_live_NEW_KEY_xyz789",
  "apiUrl": "https://api.cybersource.com",
  "currency": "USD",
  "testMode": false
}
```
  Description
  Updated configuration data. Replaces the previous data entirely. Must conform to the template's propertiesDescriptors schema. Use for credential rotation, URL changes, setting updates, or any configuration modifications. Changes are validated against the template schema before being applied.
- enabledbooleanrequired
  Example
  true
  Description
  Updated enabled status. Toggle between true/false to enable/disable the configuration without deleting data. Use for maintenance windows, phased rollouts, emergency shutdowns, or testing updated configurations before full activation.
- accessControlCfgAccessControl
  Description
  Access control settings that determine which operations can be performed on a configuration resource. This enables fine-grained permission management for configuration templates and records.
  - readbooleanrequired
    Example
    true
    Description
    Whether the configuration resource can be read/viewed. When false, the resource is hidden from queries and detail views unless the user has elevated privileges. Typically used for sensitive configurations.
  - modifybooleanrequired
    Description
    Whether the configuration resource can be modified (updated or deleted). When false, the resource becomes read-only and cannot be changed through the API. Useful for protecting production configurations.

Responses

200

Success-record updated successfully. Version automatically incremented.

400The request contained information that the server was unable to process. Appropriate errors are provided in the response body.

ValidationErrorResponse
Example
```
{
  "name": "ValidationError",
  "code": "SCHEMA_VALIDATION_FAILED",
  "detail": "Configuration data validation failed: data.apiKey is required but was not provided. Expected string with minimum length 32."
}
```
Description
Error response returned when request validation fails (HTTP 400). Contains details about which fields failed validation and why. Used for client-side error display and form validation feedback. Common when configuration data doesn't match template schema.
- namestringrequired
  Example
  ValidationError
  Description
  The error type, typically 'ValidationError' for all validation failures. Use this to distinguish validation errors from other error types in your error handling logic.
- codestringrequired
  Example
  SCHEMA_VALIDATION_FAILED
  Description
  A validation-specific error code indicating the validation rule that failed. Examples include 'REQUIRED_FIELD_MISSING', 'INVALID_FORMAT', 'VALUE_OUT_OF_RANGE', 'SCHEMA_VALIDATION_FAILED', 'TEMPLATE_NOT_FOUND'. Use for specific handling of different validation scenarios.
- detailstring
  Example
  Configuration data validation failed: data.apiKey is required but was not provided. Expected string with minimum length 32.
  Description
  Human-readable validation error message describing which field(s) failed and why. Includes specific details about what was expected vs what was provided. For schema validation failures, may include JSON path to the invalid field (e.g., 'data.apiKey is required but was not provided').

401The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.

ErrorResponse
Example
```
{
  "name": "AuthorizationError",
  "code": "INSUFFICIENT_PERMISSIONS",
  "detail": "User does not have the required tenant.cfg.modify permission to perform this operation.",
  "reason": "Your access token does not include the necessary permissions. Contact your administrator to request access."
}
```
Description
Standard error response returned when a request fails due to business logic, authorization, or system errors. Provides structured information for debugging and user-facing error messages.
- namestringrequired
  Example
  ResourceNotFoundError
  Description
  The high-level error category or type name. This is a machine-readable identifier for the class of error (e.g., 'AuthorizationError', 'ResourceNotFoundError', 'ValidationError'). Use this for programmatic error handling.
- codestringrequired
  Example
  TEMPLATE_NOT_FOUND
  Description
  A specific error code identifying the exact error condition. More granular than name, this code can be used for precise error handling and localization. Format is typically uppercase with underscores (e.g., 'TEMPLATE_NOT_FOUND', 'INSUFFICIENT_PERMISSIONS').
- detailstringrequired
  Example
  The configuration template with ID "payment-stripe" was not found in the system.
  Description
  A human-readable description of the error, including context about what went wrong. This message is suitable for display to end users or inclusion in logs. May include specifics like resource IDs or field names.
- reasonstring
  Example
  The template may have been deleted or you may not have permission to access it. Verify the template ID using GET /tenants/cfg/templates.
  Description
  Optional additional context explaining why the error occurred or what action the user should take. May include suggestions for resolution, links to documentation, or details about system state that led to the error.

404The requested resource was not found in the NoChannel system.

ErrorResponse
Example
```
{
  "name": "ResourceNotFoundError",
  "code": "TEMPLATE_NOT_FOUND",
  "detail": "The configuration template with ID \"payment-stripe\" was not found in the system.",
  "reason": "The template may have been deleted or you may not have permission to access it. Verify the template ID using GET /tenants/cfg/templates."
}
```
Description
Standard error response returned when a request fails due to business logic, authorization, or system errors. Provides structured information for debugging and user-facing error messages.
- namestringrequired
  Example
  ResourceNotFoundError
  Description
  The high-level error category or type name. This is a machine-readable identifier for the class of error (e.g., 'AuthorizationError', 'ResourceNotFoundError', 'ValidationError'). Use this for programmatic error handling.
- codestringrequired
  Example
  TEMPLATE_NOT_FOUND
  Description
  A specific error code identifying the exact error condition. More granular than name, this code can be used for precise error handling and localization. Format is typically uppercase with underscores (e.g., 'TEMPLATE_NOT_FOUND', 'INSUFFICIENT_PERMISSIONS').
- detailstringrequired
  Example
  The configuration template with ID "payment-stripe" was not found in the system.
  Description
  A human-readable description of the error, including context about what went wrong. This message is suitable for display to end users or inclusion in logs. May include specifics like resource IDs or field names.
- reasonstring
  Example
  The template may have been deleted or you may not have permission to access it. Verify the template ID using GET /tenants/cfg/templates.
  Description
  Optional additional context explaining why the error occurred or what action the user should take. May include suggestions for resolution, links to documentation, or details about system state that led to the error.

422

The request was well-formed but contains semantic errors or violates business rules that prevent processing.

ErrorResponse
Example
```
{
  "name": "UnprocessableEntityError",
  "code": "TEMPLATE_IN_USE",
  "detail": "Cannot delete template \"payment-cybersource\" because 5 configuration records are still using it.",
  "reason": "Delete or migrate all records using this template before deleting the template itself."
}
```
Description
Standard error response returned when a request fails due to business logic, authorization, or system errors. Provides structured information for debugging and user-facing error messages.
- namestringrequired
  Example
  ResourceNotFoundError
  Description
  The high-level error category or type name. This is a machine-readable identifier for the class of error (e.g., 'AuthorizationError', 'ResourceNotFoundError', 'ValidationError'). Use this for programmatic error handling.
- codestringrequired
  Example
  TEMPLATE_NOT_FOUND
  Description
  A specific error code identifying the exact error condition. More granular than name, this code can be used for precise error handling and localization. Format is typically uppercase with underscores (e.g., 'TEMPLATE_NOT_FOUND', 'INSUFFICIENT_PERMISSIONS').
- detailstringrequired
  Example
  The configuration template with ID "payment-stripe" was not found in the system.
  Description
  A human-readable description of the error, including context about what went wrong. This message is suitable for display to end users or inclusion in logs. May include specifics like resource IDs or field names.
- reasonstring
  Example
  The template may have been deleted or you may not have permission to access it. Verify the template ID using GET /tenants/cfg/templates.
  Description
  Optional additional context explaining why the error occurred or what action the user should take. May include suggestions for resolution, links to documentation, or details about system state that led to the error.

500

An unexpected internal server error occurred. The request may be retried, and if the problem persists, contact support with the traceId from the error response.

ErrorResponse
Example
```
{
  "name": "InternalServerError",
  "code": "UNEXPECTED_ERROR",
  "detail": "An unexpected error occurred while processing your request.",
  "reason": "Our team has been notified. Please try again, and if the problem persists, contact support with trace ID: 550e8400-e29b-41d4-a716-446655440000"
}
```
Description
Standard error response returned when a request fails due to business logic, authorization, or system errors. Provides structured information for debugging and user-facing error messages.
- namestringrequired
  Example
  ResourceNotFoundError
  Description
  The high-level error category or type name. This is a machine-readable identifier for the class of error (e.g., 'AuthorizationError', 'ResourceNotFoundError', 'ValidationError'). Use this for programmatic error handling.
- codestringrequired
  Example
  TEMPLATE_NOT_FOUND
  Description
  A specific error code identifying the exact error condition. More granular than name, this code can be used for precise error handling and localization. Format is typically uppercase with underscores (e.g., 'TEMPLATE_NOT_FOUND', 'INSUFFICIENT_PERMISSIONS').
- detailstringrequired
  Example
  The configuration template with ID "payment-stripe" was not found in the system.
  Description
  A human-readable description of the error, including context about what went wrong. This message is suitable for display to end users or inclusion in logs. May include specifics like resource IDs or field names.
- reasonstring
  Example
  The template may have been deleted or you may not have permission to access it. Verify the template ID using GET /tenants/cfg/templates.
  Description
  Optional additional context explaining why the error occurred or what action the user should take. May include suggestions for resolution, links to documentation, or details about system state that led to the error.

curl

curl --request PUT \
     --url https://api.upstartcommerce.com/v1/tenants/cfg/records/{recordId} \
     --header 'accept: text/plain' \
     --header 'content-type: application/json' \
     --header 'x-upstart-tenant: string' \
     --data '{
     "templateId": "payment-cybersource",
     "name": "Cybersource US Production Credentials - Updated Q1 2025",
     "data": "{\"merchantId\":\"acme_us_prod\",\"apiKey\":\"sk_live_NEW_KEY_xyz789\",\"apiUrl\":\"https://api.cybersource.com\",\"currency\":\"USD\",\"testMode\":false}",
     "enabled": true,
     "accessControl": {
     "read": true,
     "modify": false
     }
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "text/plain");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-upstart-tenant", "string");

var raw = JSON.stringify({
   "templateId": "payment-cybersource",
   "name": "Cybersource US Production Credentials - Updated Q1 2025",
   "data": "{\"merchantId\":\"acme_us_prod\",\"apiKey\":\"sk_live_NEW_KEY_xyz789\",\"apiUrl\":\"https://api.cybersource.com\",\"currency\":\"USD\",\"testMode\":false}",
   "enabled": true,
   "accessControl": {
      "read": true,
      "modify": false
   }
});

var requestOptions = {
   method: 'PUT',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.upstartcommerce.com/v1/tenants/cfg/records/{recordId}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.upstartcommerce.com/v1/tenants/cfg/records/{recordId}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Put.new(url)
request["accept"] = "text/plain"
request["content-type"] = "application/json"
request["x-upstart-tenant"] = "string"
request.body = JSON.dump({
   "templateId": "payment-cybersource",
   "name": "Cybersource US Production Credentials - Updated Q1 2025",
   "data": "{\"merchantId\":\"acme_us_prod\",\"apiKey\":\"sk_live_NEW_KEY_xyz789\",\"apiUrl\":\"https://api.cybersource.com\",\"currency\":\"USD\",\"testMode\":false}",
   "enabled": true,
   "accessControl": {
      "read": true,
      "modify": false
   }
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.upstartcommerce.com/v1/tenants/cfg/records/{recordId}"

payload = json.dumps({
   "templateId": "payment-cybersource",
   "name": "Cybersource US Production Credentials - Updated Q1 2025",
   "data": "{\"merchantId\":\"acme_us_prod\",\"apiKey\":\"sk_live_NEW_KEY_xyz789\",\"apiUrl\":\"https://api.cybersource.com\",\"currency\":\"USD\",\"testMode\":false}",
   "enabled": True,
   "accessControl": {
      "read": True,
      "modify": False
   }
})
headers = {
   'accept': 'text/plain',
   'content-type': 'application/json',
   'x-upstart-tenant': 'string'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

200

// Success-record updated successfully. Version automatically incremented.

400

// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.
{
  "name": "ValidationError",
  "code": "SCHEMA_VALIDATION_FAILED",
  "detail": "Configuration data validation failed: data.apiKey is required but was not provided. Expected string with minimum length 32."
}

401

// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.
{
  "name": "ResourceNotFoundError",
  "code": "TEMPLATE_NOT_FOUND",
  "detail": "The configuration template with ID \"payment-stripe\" was not found in the system.",
  "reason": "The template may have been deleted or you may not have permission to access it. Verify the template ID using GET /tenants/cfg/templates."
}

404

// The requested resource was not found in the NoChannel system.
{
  "name": "ResourceNotFoundError",
  "code": "TEMPLATE_NOT_FOUND",
  "detail": "The configuration template with ID \"payment-stripe\" was not found in the system.",
  "reason": "The template may have been deleted or you may not have permission to access it. Verify the template ID using GET /tenants/cfg/templates."
}

422

// The request was well-formed but contains semantic errors or violates business rules that prevent processing.
{
  "name": "ResourceNotFoundError",
  "code": "TEMPLATE_NOT_FOUND",
  "detail": "The configuration template with ID \"payment-stripe\" was not found in the system.",
  "reason": "The template may have been deleted or you may not have permission to access it. Verify the template ID using GET /tenants/cfg/templates."
}

500

// An unexpected internal server error occurred. The request may be retried, and if the problem persists, contact support with the traceId from the error response.
{
  "name": "ResourceNotFoundError",
  "code": "TEMPLATE_NOT_FOUND",
  "detail": "The configuration template with ID \"payment-stripe\" was not found in the system.",
  "reason": "The template may have been deleted or you may not have permission to access it. Verify the template ID using GET /tenants/cfg/templates."
}