Unpin feed(s) for a preference key

DELETE /mywork/v1/user-preferences/{pref_key}/{feed_key}

Operation id: unpinTaskPreferences

Description

Removes one or more feed keys from the user's home-unit preference list for {pref_key} (v1: TASK_PINS only).

Same feed_key / CSV rules as pin. Missing feed_key (including DELETE .../{pref_key} with no feed segment) → E105 — no clear-all via this API.


Error Scenarios

ScenarioHTTPError CodeMessage
Missing / empty feed_key400E105feed_key is mandatory
Non-numeric / non-positive token400E159Invalid feed_key
Home unit id blank400E107Unit id is mandatory
Unable to update preference500E358Unable to update preference

Tags: MyWorkUserPreferences

Parameters

Path parameters

NameTypeRequiredDescription
feed_keystringYesFeed key to pin/unpin. Single id (101) or CSV (101,202). Missing / empty → E105. Non-numeric / non-positive tokens → E159.
pref_keystringYesPreference key. v1 allowlists TASK_PINS only (→ E228 otherwise). Controllers currently bind pin/unpin helpers to this key; clients must send the literal value TASK_PINS.

Security

  • ApiKeyHeader (apiKey)
    • APIGEE API key header validated by VerifyAPIKey policy.
  • AuthTokenHeader (apiKey)
    • Session authentication token validated server-side against the user session store.

Responses

200 — Success — updated pin list under task_pins plus localized message

Content type: application/json

400 — E105 / E107 / E159

Content type: application/json

401 — Invalid or expired X-reflexis-csrf-token-X token (HTTP 401)

Content type: application/json

500 — Unexpected server-side error

Content type: application/json

Response models

200 — Success — updated pin list under task_pins plus localized message

Content type: application/json

Schema

PropertyTypeRequiredDescription
statusstringYes
task_pinsarrayYes
messagestringYesLocalized confirmation (e.g. Unpinned)
{
  "type": "object",
  "required": [
    "status",
    "task_pins",
    "message"
  ],
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "OK"
      ]
    },
    "task_pins": {
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "message": {
      "type": "string",
      "description": "Localized confirmation (e.g. `Unpinned`)"
    }
  }
}

Example:

{
  "status": "OK",
  "task_pins": [
    101
  ],
  "message": "Unpinned"
}

400 — E105 / E107 / E159

Content type: application/json

Schema

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E204, E112, E302)
responsestringYesHuman-readable error message
{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E204",
    "response": "Invalid or expired token"
  },
  "required": [
    "status",
    "errorCode",
    "response"
  ],
  "properties": {
    "status": {
      "type": "string",
      "description": "Always \"ER\" for error responses",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Application-level error code (e.g. E204, E112, E302)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

401 — Invalid or expired X-reflexis-csrf-token-X token (HTTP 401)

Content type: application/json

Schema

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E204, E112, E302)
responsestringYesHuman-readable error message
{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E204",
    "response": "Invalid or expired token"
  },
  "required": [
    "status",
    "errorCode",
    "response"
  ],
  "properties": {
    "status": {
      "type": "string",
      "description": "Always \"ER\" for error responses",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Application-level error code (e.g. E204, E112, E302)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

Example:

{
  "status": "ER",
  "errorCode": "E204",
  "response": "Invalid or expired token"
}

500 — Unexpected server-side error

Content type: application/json

Schema

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E204, E112, E302)
responsestringYesHuman-readable error message
{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E204",
    "response": "Invalid or expired token"
  },
  "required": [
    "status",
    "errorCode",
    "response"
  ],
  "properties": {
    "status": {
      "type": "string",
      "description": "Always \"ER\" for error responses",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Application-level error code (e.g. E204, E112, E302)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

Example:

{
  "status": "ER",
  "errorCode": "E302",
  "response": "Internal server error"
}