Change ActiveMQ Consumer Custom Properties (API) – meshIQ

This article shows how to update the configuration of custom properties for a specific ActiveMQ consumer using the REST API.

Change ActiveMQ Consumer Custom Properties

PATCH
/activemq/consumers/{nodeName}/{managerName}/{brokerName}/{consumerName}/custom-properties

Updates the custom properties of a specific ActiveMQ consumer.

Example Request

curl -X 'PATCH' \
  'http://<hostname>:8019/rest/v1/activemq/consumers/CMACTIVEMQ/Activemq-serve/DemoBroker/NOTSET%3A0%3A-1/custom-properties' \
  -H 'accept: */*' \
  -H 'Authorization: Basic QWRtaW46YWRtaW4=' \
  -H 'Content-Type: application/json' \
  -d '{
  "additionalProp1": "consumerprop1",
  "additionalProp2": "2",
  "additionalProp3": "string"
}'

Query Parameters

Parameter	Type	Description
`jobDate`	integer	Schedule job date (Unix Timestamp).
`jobTags`	string	Comma-separated list of job tags (used only with jobDate).
`validateAccessForUser`	string	Validate endpoint access for the user.
`waitForRead`	boolean	Wait for cache update.

Request Body

{
  "additionalProp1": "string",
  "additionalProp2": "string",
  "additionalProp3": "string"
}

Response Codes

204 No Content – Object updated successfully.
304 Not Modified – No changes applied.
* – Error response, returns ErrorPojo.

Response Header

204 No Content: Successfully updated

 access-control-allow-credentials: true 
 access-control-allow-origin: http://<hostname>:8019 
 date: Mon,29 Sep 2025 08:41:09 GMT 
 server: Jetty(10.0.22) 
 vary: Origin

Reference Articles

Using the REST API using the Navigator demo system

Performing REST API operations using the Swagger UI