---
updatedAt: 2026-07-28T13:51:09.000Z
---
# (EA) Update a client profile name configuration template
Update a client profile name configuration template.
Your token must have one of the permissions listed in the Token Permissions.
Token Permissions: [ `ep_configuration_template:update:*` ]
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "Event Portal - Designer",
"description": "REST API Concepts\n\nSolace Event Portal provides REST APIs that you can use to manage your data in Solace Cloud. \nThe REST APIs allow you to model your event-driven architectures from your own client applications.\n\nThe following document describes the public REST APIs available for use in Event Portal 2.0. Objects created in this \nversion will not be available in Event Portal 1.0. APIs that display (Beta) in their summary are provided as-is and \nare subject to change or removal. They may not be of the quality expected for generally available APIs and have no \nguaranteed forward compatibility with the generally available version of the API.\n\n",
"version": "2.13.2"
},
"servers": [
{
"url": "https://api.solace.cloud",
"description": "Solace PubSub+ Cloud US EAST Region"
},
{
"url": "https://api.solacecloud.com.au",
"description": "Solace PubSub+ Cloud AU Region"
},
{
"url": "https://api.solacecloud.eu",
"description": "Solace PubSub+ Cloud EU Region"
},
{
"url": "https://api.solacecloud.sg",
"description": "Solace PubSub+ Cloud SG Region"
}
],
"security": [
{
"APIToken": []
}
],
"tags": [
{
"name": "Configuration Templates"
}
],
"paths": {
"/api/v2/architecture/configurationTemplate/solaceClientProfileNames/{id}": {
"patch": {
"tags": [
"Configuration Templates"
],
"summary": "(EA) Update a client profile name configuration template",
"description": "Update a client profile name configuration template.\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `ep_configuration_template:update:*` ]",
"operationId": "updateSolaceClientProfileNameConfigurationTemplate",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The unique identifier of the client profile name configuration template.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The JSON schema that defines the client profile name configuration template.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SolaceClientProfileName"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "The updated solace client profile name configuration template.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SolaceClientProfileNameConfigurationTemplateResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"501": {
"description": "Not Implemented",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"ErrorResponse": {
"type": "object",
"discriminator": {
"propertyName": "errorType"
},
"properties": {
"message": {
"type": "string",
"description": "A user-friendly message that describes the error.",
"example": "An error occurred."
},
"errorId": {
"type": "string",
"description": "The UUID (Universally Unique Identifier) that is logged with an appropriate stack trace for a WARN or ERROR log that allows support to better determine what cause the error.",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"meta": {
"type": "object",
"additionalProperties": {},
"example": "'object': { 'field': 'description' }"
},
"validationDetails": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "When applicable, these are the details of issues with the fields provided for the REST call.",
"example": "'name': ['Not unique']"
},
"errorType": {
"type": "string",
"writeOnly": true
}
}
},
"InvalidNonStateReference": {
"type": "object",
"properties": {
"entityId": {
"type": "string"
},
"entityType": {
"type": "string"
}
}
},
"InvalidStateReference": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorResponse"
},
{
"type": "object",
"properties": {
"targetStateId": {
"type": "string"
},
"inboundInvalidNonStateReferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvalidNonStateReference"
}
},
"inboundInvalidStateReferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvalidStateReference"
}
},
"outboundInvalidStateReferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvalidStateReference"
}
},
"errorType": {
"type": "string"
}
}
}
]
},
"Pagination": {
"type": "object",
"properties": {
"pageNumber": {
"type": "integer",
"format": "int32"
},
"count": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"nextPage": {
"type": "integer",
"format": "int32"
},
"totalPages": {
"type": "integer",
"format": "int32"
}
}
},
"SolaceClientProfileName": {
"type": "object",
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"example": "xyz23mwec2g",
"readOnly": true
},
"name": {
"type": "string",
"example": "My Client Profile Name Template",
"maxLength": 255,
"minLength": 1
},
"description": {
"type": "string",
"example": "This is a client profile name template to be used when deploying to environments",
"maxLength": 10000
},
"configurationTypeId": {
"type": "string",
"description": "See Get a list of configuration types for detail.",
"example": "solaceClientProfileName",
"readOnly": true
},
"value": {
"type": "object",
"additionalProperties": {},
"description": "The configuration template in JSON format",
"example": "'object': { 'clientProfileName': 'name' }"
},
"associatedApplicationVersionIds": {
"type": "array",
"description": "The list of application version IDs associated with this Solace Client Profile Name Configuration template",
"example": "['applicationVersionId1', 'applicationVersionId2']",
"items": {
"type": "string"
},
"readOnly": true
},
"environmentIds": {
"type": "array",
"description": "The list of environment IDs associated with this Solace Client Profile Name Configuration template",
"example": "['environmentId1']",
"items": {
"type": "string"
},
"readOnly": true
},
"type": {
"type": "string"
}
}
},
"SolaceClientProfileNameConfigurationTemplateResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SolaceClientProfileName"
},
"meta": {
"$ref": "#/components/schemas/meta"
}
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"$ref": "#/components/schemas/Pagination"
}
}
}
},
"securitySchemes": {
"APIToken": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
},
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true
}
}
```