Create/Update Configuration Record Resource

1 min

POST

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

This endpoint create/update cfg record resource.

Authorized permissions:

tenant.cfg.modify

Path Parameters

recordIdstringrequired
Description
Unique identifier for a given record.
namestringrequired
Description
Unique name for the record resource.

Header Parameters

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

Form Parameters

filestring<binary>
Description
The resource file to upload (e.g., images, certificates, or other binary data).
Format
binary

Responses

200

Success-resource created/updated successfully.

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.

curl

curl --request POST \
     --url https://api.upstartcommerce.com/v1/tenants/cfg/records/{recordId}/resources/{name} \
     --header 'accept: application/json' \
     --header 'x-upstart-tenant: string'

javascript

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

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   redirect: 'follow'
};

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

ruby

require "uri"
require "net/http"

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

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

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "multipart/form-data"
request["x-upstart-tenant"] = "string"

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

python

import requests

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

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'multipart/form-data',
   'x-upstart-tenant': 'string'
}

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

print(response.text)

200

// Success-resource created/updated successfully.

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