Updates a place group category's code and name
Use this endpoint to rename a place group category. Automatic categories cannot be updated.
The new code must be unique across all categories.
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
| ECI-ApiKey | string | Yes | Your API key. See Authentication. |
| Content-Type | application/json | Yes | All requests must specify JSON content type, including the request body. |
Path Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| categoryId | Unique numeric identifier of the category to update | integer (int32) | Required |
Request Body
PlaceCategoryRequest
| Property | Description | Type |
|---|---|---|
| placeGroupCategoryCode | The place category code Required Must be between 0 and 32 characters | string |
| placeGroupCategoryInfo | The place category info Required Must be between 0 and 32 characters | string |
Example Request Body
{ "placeGroupCategoryCode": "string", "placeGroupCategoryInfo": "string"
}
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
PlaceCategoryResponse
| Property | Description | Type |
|---|---|---|
| autoGroup | Is this category an automatically maintained one? | boolean |
| numberOfGroups | Number of groups within this category | integer (int32) |
| numberOfGroupsWithVisibleMembers | Number of groups within this category with members the logged in can see | integer (int32) |
| placeGroupCategoryCode | The place category code | string |
| placeGroupCategoryId | The place category identifier | integer (int32) |
| placeGroupCategoryInfo | The place category name | string |
Example Response
{ "autoGroup": false, "numberOfGroups": 1, "numberOfGroupsWithVisibleMembers": 1, "placeGroupCategoryCode": "string", "placeGroupCategoryId": 1, "placeGroupCategoryInfo": "string"
}
400
Bad Request
The request was malformed or contains invalid parameters. Check the request body and query parameters.
404
Not Found
The requested resource was not found. Verify the ID or path is correct.