Update Configuration Template

1 min

PUT

https://api.upstartcommerce.com/v1/tenants/cfg/templates/{templateId}

This endpoint update cfg template.

Authorized permissions:

tenant.cfg.modify

Path Parameters

templateIdstringrequired
Description
Unique identifier for a given template.

Header Parameters

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

Body Parameters

bodyUpdateCfgTemplaterequired

Example

{
  "name": "Cybersource Payment Gateway Configuration v2",
  "propertiesDec": {
    "type": "object",
    "properties": {
      "merchantId": {
        "type": "string",
        "description": "Merchant identifier"
      },
      "apiKey": {
        "type": "string",
        "format": "password",
        "minLength": 32
      },
      "apiSecret": {
        "type": "string",
        "format": "password",
        "description": "NEW: API secret for enhanced security"
      },
      "apiUrl": {
        "type": "string",
        "format": "uri",
        "default": "https://api.cybersource.com"
      },
      "currency": {
        "type": "string",
        "enum": [
          "USD",
          "EUR",
          "GBP",
          "CAD"
        ],
        "default": "USD"
      }
    },
    "required": [
      "merchantId",
      "apiKey"
    ]
  },
  "enabled": true,
  "accessControl": {
    "read": true,
    "modify": false
  }
}

Description

The configuration template fields to update.

namestringrequired
Example
Cybersource Payment Gateway Configuration v2
Description
Updated human-readable name for the template. Use to clarify purpose, reflect updated integration versions, or improve naming conventions. Should remain descriptive of what configurations use this template.

propertiesDecobjectrequired

Example

{
  "type": "object",
  "properties": {
    "merchantId": {
      "type": "string",
      "description": "Merchant identifier from Cybersource",
      "pattern": "^[a-zA-Z0-9_-]+$"
    },
    "apiKey": {
      "type": "string",
      "description": "API key for authentication",
      "format": "password",
      "minLength": 32
    },
    "apiSecret": {
      "type": "string",
      "description": "NEW FIELD: API secret for enhanced security",
      "format": "password",
      "minLength": 32
    },
    "apiUrl": {
      "type": "string",
      "format": "uri",
      "default": "https://api.cybersource.com",
      "description": "Cybersource API base URL"
    },
    "currency": {
      "type": "string",
      "enum": [
        "USD",
        "EUR",
        "GBP",
        "CAD"
      ],
      "default": "USD",
      "description": "Default currency"
    },
    "testMode": {
      "type": "boolean",
      "default": false
    },
    "webhookUrl": {
      "type": "string",
      "format": "uri",
      "description": "NEW FIELD: Optional webhook for payment notifications"
    }
  },
  "required": [
    "merchantId",
    "apiKey"
  ]
}

Description

Updated Properties Descriptors (JSON Schema). This is where schema evolution happens. You can: add new optional fields (backward compatible), change validation rules, update descriptions, add new enums, modify defaults. CAUTION: Removing required fields or making breaking changes affects existing records. Plan migrations carefully. Template version auto-increments to track schema changes.

enabledbooleanrequired
Example
true
Description
Updated enabled status. Set to false to deprecate a template and prevent creation of new records while allowing existing records to continue working. Set to true to reactivate a disabled template. Use for template lifecycle management.
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-template 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/templates/{templateId} \
     --header 'accept: text/plain' \
     --header 'content-type: application/json' \
     --header 'x-upstart-tenant: string' \
     --data '{
     "name": "Cybersource Payment Gateway Configuration v2",
     "propertiesDec": "{\"type\":\"object\",\"properties\":{\"merchantId\":{\"type\":\"string\",\"description\":\"Merchant identifier from Cybersource\",\"pattern\":\"^[a-zA-Z0-9_-]+$\"},\"apiKey\":{\"type\":\"string\",\"description\":\"API key for authentication\",\"format\":\"password\",\"minLength\":32},\"apiSecret\":{\"type\":\"string\",\"description\":\"NEW FIELD: API secret for enhanced security\",\"format\":\"password\",\"minLength\":32},\"apiUrl\":{\"type\":\"string\",\"format\":\"uri\",\"default\":\"https://api.cybersource.com\",\"description\":\"Cybersource API base URL\"},\"currency\":{\"type\":\"string\",\"enum\":[\"USD\",\"EUR\",\"GBP\",\"CAD\"],\"default\":\"USD\",\"description\":\"Default currency\"},\"testMode\":{\"type\":\"boolean\",\"default\":false},\"webhookUrl\":{\"type\":\"string\",\"format\":\"uri\",\"description\":\"NEW FIELD: Optional webhook for payment notifications\"}},\"required\":[\"merchantId\",\"apiKey\"]}",
     "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({
   "name": "Cybersource Payment Gateway Configuration v2",
   "propertiesDec": "{\"type\":\"object\",\"properties\":{\"merchantId\":{\"type\":\"string\",\"description\":\"Merchant identifier from Cybersource\",\"pattern\":\"^[a-zA-Z0-9_-]+$\"},\"apiKey\":{\"type\":\"string\",\"description\":\"API key for authentication\",\"format\":\"password\",\"minLength\":32},\"apiSecret\":{\"type\":\"string\",\"description\":\"NEW FIELD: API secret for enhanced security\",\"format\":\"password\",\"minLength\":32},\"apiUrl\":{\"type\":\"string\",\"format\":\"uri\",\"default\":\"https://api.cybersource.com\",\"description\":\"Cybersource API base URL\"},\"currency\":{\"type\":\"string\",\"enum\":[\"USD\",\"EUR\",\"GBP\",\"CAD\"],\"default\":\"USD\",\"description\":\"Default currency\"},\"testMode\":{\"type\":\"boolean\",\"default\":false},\"webhookUrl\":{\"type\":\"string\",\"format\":\"uri\",\"description\":\"NEW FIELD: Optional webhook for payment notifications\"}},\"required\":[\"merchantId\",\"apiKey\"]}",
   "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/templates/{templateId}", 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/templates/{templateId}")

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({
   "name": "Cybersource Payment Gateway Configuration v2",
   "propertiesDec": "{\"type\":\"object\",\"properties\":{\"merchantId\":{\"type\":\"string\",\"description\":\"Merchant identifier from Cybersource\",\"pattern\":\"^[a-zA-Z0-9_-]+$\"},\"apiKey\":{\"type\":\"string\",\"description\":\"API key for authentication\",\"format\":\"password\",\"minLength\":32},\"apiSecret\":{\"type\":\"string\",\"description\":\"NEW FIELD: API secret for enhanced security\",\"format\":\"password\",\"minLength\":32},\"apiUrl\":{\"type\":\"string\",\"format\":\"uri\",\"default\":\"https://api.cybersource.com\",\"description\":\"Cybersource API base URL\"},\"currency\":{\"type\":\"string\",\"enum\":[\"USD\",\"EUR\",\"GBP\",\"CAD\"],\"default\":\"USD\",\"description\":\"Default currency\"},\"testMode\":{\"type\":\"boolean\",\"default\":false},\"webhookUrl\":{\"type\":\"string\",\"format\":\"uri\",\"description\":\"NEW FIELD: Optional webhook for payment notifications\"}},\"required\":[\"merchantId\",\"apiKey\"]}",
   "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/templates/{templateId}"

payload = json.dumps({
   "name": "Cybersource Payment Gateway Configuration v2",
   "propertiesDec": "{\"type\":\"object\",\"properties\":{\"merchantId\":{\"type\":\"string\",\"description\":\"Merchant identifier from Cybersource\",\"pattern\":\"^[a-zA-Z0-9_-]+$\"},\"apiKey\":{\"type\":\"string\",\"description\":\"API key for authentication\",\"format\":\"password\",\"minLength\":32},\"apiSecret\":{\"type\":\"string\",\"description\":\"NEW FIELD: API secret for enhanced security\",\"format\":\"password\",\"minLength\":32},\"apiUrl\":{\"type\":\"string\",\"format\":\"uri\",\"default\":\"https://api.cybersource.com\",\"description\":\"Cybersource API base URL\"},\"currency\":{\"type\":\"string\",\"enum\":[\"USD\",\"EUR\",\"GBP\",\"CAD\"],\"default\":\"USD\",\"description\":\"Default currency\"},\"testMode\":{\"type\":\"boolean\",\"default\":false},\"webhookUrl\":{\"type\":\"string\",\"format\":\"uri\",\"description\":\"NEW FIELD: Optional webhook for payment notifications\"}},\"required\":[\"merchantId\",\"apiKey\"]}",
   "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-template 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."
}