Update a single walk template feature (permission attribute)
POST /walk-creator/v1/templates/features
Operation id: updateWalkTemplateFeature
Description
Merges a partial permission_attr JSON payload into the walk template's stored PERMISSION_ATTR and returns the updated template.
Use this endpoint when toggling one feature on the modern walk template Features screen instead of posting the full feature list via legacy saveTemplateFeatures.
Merge semantics: only keys present in permission_attr are updated; all other permission attributes remain unchanged.
Side effects (same as legacy feature save):
- Enabling link walk (
externalWalk=Y) may reset schedule type and clear distribution, reviewer, and walk-permission data when transitioning to external walk. - Disabling scoring or follow-up tasks triggers related cleanup via post-update processing.
- Collaborative walk, response history, and offline walk changes may update related question or permission data.
Authentication: X-reflexis-csrf-token-X required. Caller must have template edit access.
Success response
{
"status": "OK",
"template": {
"model_id": "FORM_123",
"model_name": "Store Walk",
"permission_attr": "{\"showRecall\":\"Y\", ...}"
}
}
Error scenarios
| Scenario | HTTP Status | Message |
|---|---|---|
Missing X-reflexis-csrf-token-X header | 400 | X-reflexis-csrf-token-X header is mandatory |
| Invalid or expired token | 401 | Invalid or expired token |
Missing model_id | 400 | model_id is mandatory |
Missing permission_attr | 400 | permission_attr is mandatory |
| Invalid template access | 200 | status: ER, Invalid Template Access |
| Template not found | 200 | status: ER, business error string |
| Persist failure | 200 | status: ER, business error string |
Tags: WalkCreatorTemplateFeatures
Security
- ApiKeyHeader (apiKey)
- APIGEE API key header validated by VerifyAPIKey policy.
- AuthTokenHeader (apiKey)
- Session authentication token validated server-side against the user session store. Required on every request. Absence returns HTTP 400; invalid/expired token returns HTTP 401.
Responses
200 — Success returns status: OK and the updated template under template.
Application-level failures return HTTP 200 with status: ER.
Content type: application/json
400 — Invalid or missing required request parameter.
Content type: application/json
401 — Missing or invalid X-reflexis-csrf-token-X session token.
Content type: application/json
500 — Unexpected server-side error.
Content type: application/json
Request body
Required: Yes
application/x-www-form-urlencoded
Schema
| Property | Type | Required | Description |
|---|---|---|---|
model_id | string | Yes | Walk template MODEL_ID to update. |
permission_attr | string | Yes | URL-encoded JSON string containing one or more permission attribute keys to merge (see WalkCreatorTemplateFeaturePayload). Example value before encoding: {"showRecall":"Y"}. |
group_instance_name | string | No | Optional. Used when showAsWalk in the merged permission attributes is G (group walk display mode). |
{
"type": "object",
"required": [
"model_id",
"permission_attr"
],
"properties": {
"model_id": {
"type": "string",
"description": "Walk template `MODEL_ID` to update.",
"example": "FORM_123"
},
"permission_attr": {
"type": "string",
"description": "URL-encoded JSON string containing one or more permission attribute keys\nto merge (see `WalkCreatorTemplateFeaturePayload`). Example value before\nencoding: `{\"showRecall\":\"Y\"}`.\n",
"example": "{\"showRecall\":\"Y\"}"
},
"group_instance_name": {
"type": "string",
"description": "Optional. Used when `showAsWalk` in the merged permission attributes is `G`\n(group walk display mode).\n"
}
}
}
Response models
200 — Success returns status: OK and the updated template under template.
Application-level failures return HTTP 200 with status: ER.
Content type: application/json
Schema
{
"oneOf": [
{
"type": "object",
"required": [
"status",
"template"
],
"properties": {
"status": {
"type": "string",
"enum": [
"OK"
]
},
"template": {
"type": "object",
"description": "Updated walk template returned under `template` after a successful feature update.\nSame shape as a `templateList[]` entry from legacy template retrieve APIs; response\nkeys use **snake_case** (next-gen convention).\n"
}
}
},
{
"type": "object",
"description": "Error envelope shape depends on how the error is produced:\n\n- **HTTP 200** — business or validation failure after the request is accepted:\n `{ \"status\": \"ER\", \"error\": \"<string or JSON>\" }` (no `errorCode`).\n- **HTTP 4xx/5xx** — structured API error:\n `{ \"status\": \"ER\", \"errorCode\": \"<code>\", \"response\": \"<localized message>\" }`.\n",
"properties": {
"status": {
"type": "string",
"enum": [
"ER"
]
},
"errorCode": {
"type": "string",
"description": "Structured error code for HTTP 4xx/5xx responses."
},
"response": {
"type": "string",
"description": "Human-readable message when `errorCode` is present (HTTP 4xx/5xx responses)."
},
"error": {
"description": "Payload for HTTP 200 error bodies (string, array, or object).",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {}
},
{
"type": "object"
}
]
}
}
}
]
}
400 — Invalid or missing required request parameter.
Content type: application/json
Schema
Error envelope shape depends on how the error is produced:
- HTTP 200 — business or validation failure after the request is accepted:
{ "status": "ER", "error": "<string or JSON>" }(noerrorCode). - HTTP 4xx/5xx — structured API error:
{ "status": "ER", "errorCode": "<code>", "response": "<localized message>" }.
| Property | Type | Required | Description |
|---|---|---|---|
status | string | No | |
errorCode | string | No | Structured error code for HTTP 4xx/5xx responses. |
response | string | No | Human-readable message when errorCode is present (HTTP 4xx/5xx responses). |
error | oneOf | No | Payload for HTTP 200 error bodies (string, array, or object). |
{
"type": "object",
"description": "Error envelope shape depends on how the error is produced:\n\n- **HTTP 200** — business or validation failure after the request is accepted:\n `{ \"status\": \"ER\", \"error\": \"<string or JSON>\" }` (no `errorCode`).\n- **HTTP 4xx/5xx** — structured API error:\n `{ \"status\": \"ER\", \"errorCode\": \"<code>\", \"response\": \"<localized message>\" }`.\n",
"properties": {
"status": {
"type": "string",
"enum": [
"ER"
]
},
"errorCode": {
"type": "string",
"description": "Structured error code for HTTP 4xx/5xx responses."
},
"response": {
"type": "string",
"description": "Human-readable message when `errorCode` is present (HTTP 4xx/5xx responses)."
},
"error": {
"description": "Payload for HTTP 200 error bodies (string, array, or object).",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {}
},
{
"type": "object"
}
]
}
}
}
Example:
{
"status": "ER",
"errorCode": "E110",
"response": "model_id is mandatory"
}
401 — Missing or invalid X-reflexis-csrf-token-X session token.
Content type: application/json
Schema
Error envelope shape depends on how the error is produced:
- HTTP 200 — business or validation failure after the request is accepted:
{ "status": "ER", "error": "<string or JSON>" }(noerrorCode). - HTTP 4xx/5xx — structured API error:
{ "status": "ER", "errorCode": "<code>", "response": "<localized message>" }.
| Property | Type | Required | Description |
|---|---|---|---|
status | string | No | |
errorCode | string | No | Structured error code for HTTP 4xx/5xx responses. |
response | string | No | Human-readable message when errorCode is present (HTTP 4xx/5xx responses). |
error | oneOf | No | Payload for HTTP 200 error bodies (string, array, or object). |
{
"type": "object",
"description": "Error envelope shape depends on how the error is produced:\n\n- **HTTP 200** — business or validation failure after the request is accepted:\n `{ \"status\": \"ER\", \"error\": \"<string or JSON>\" }` (no `errorCode`).\n- **HTTP 4xx/5xx** — structured API error:\n `{ \"status\": \"ER\", \"errorCode\": \"<code>\", \"response\": \"<localized message>\" }`.\n",
"properties": {
"status": {
"type": "string",
"enum": [
"ER"
]
},
"errorCode": {
"type": "string",
"description": "Structured error code for HTTP 4xx/5xx responses."
},
"response": {
"type": "string",
"description": "Human-readable message when `errorCode` is present (HTTP 4xx/5xx responses)."
},
"error": {
"description": "Payload for HTTP 200 error bodies (string, array, or object).",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {}
},
{
"type": "object"
}
]
}
}
}
500 — Unexpected server-side error.
Content type: application/json
Schema
Error envelope shape depends on how the error is produced:
- HTTP 200 — business or validation failure after the request is accepted:
{ "status": "ER", "error": "<string or JSON>" }(noerrorCode). - HTTP 4xx/5xx — structured API error:
{ "status": "ER", "errorCode": "<code>", "response": "<localized message>" }.
| Property | Type | Required | Description |
|---|---|---|---|
status | string | No | |
errorCode | string | No | Structured error code for HTTP 4xx/5xx responses. |
response | string | No | Human-readable message when errorCode is present (HTTP 4xx/5xx responses). |
error | oneOf | No | Payload for HTTP 200 error bodies (string, array, or object). |
{
"type": "object",
"description": "Error envelope shape depends on how the error is produced:\n\n- **HTTP 200** — business or validation failure after the request is accepted:\n `{ \"status\": \"ER\", \"error\": \"<string or JSON>\" }` (no `errorCode`).\n- **HTTP 4xx/5xx** — structured API error:\n `{ \"status\": \"ER\", \"errorCode\": \"<code>\", \"response\": \"<localized message>\" }`.\n",
"properties": {
"status": {
"type": "string",
"enum": [
"ER"
]
},
"errorCode": {
"type": "string",
"description": "Structured error code for HTTP 4xx/5xx responses."
},
"response": {
"type": "string",
"description": "Human-readable message when `errorCode` is present (HTTP 4xx/5xx responses)."
},
"error": {
"description": "Payload for HTTP 200 error bodies (string, array, or object).",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {}
},
{
"type": "object"
}
]
}
}
}
Example:
{
"status": "ER",
"errorCode": "E500",
"response": "Unexpected server error."
}