Pin a UI protocol session¶
Maintain the current user’s session records.
PUT https://api.moi.matrixorigin.cn/v5/sessions/{session_id}/pin
Before you call this API¶
Set BASE_URL to the product API prefix https://api.moi.matrixorigin.cn/v5. For private deployments, use the corresponding product API URL.
Configure identity, Workspace, and numeric record IDs in the same environment. This entry point uses ordinary product authentication and rejects additional task runtime authorization headers.
Request¶
curl --request PUT \
"$BASE_URL/sessions/$SESSION_ID/pin" \
--header "X-API-Key: $MOI_KEY" \
--header "X-Workspace-ID: $WORKSPACE_ID"
Parameter |
Location |
Type |
Required |
Description |
|---|---|---|---|---|
|
Headers |
string |
Yes |
Target Workspace ID. |
|
Path |
integer |
Yes |
Positive integer ID of the current user’s record. |
Returns HTTP 200 and an operation-result object, not 204. Sets or removes the system/pinned relationship. Confirm through pinned reads rather than empty tags in the session object.
Successful response¶
{
"code": "OK",
"msg": "OK",
"data": {
"message": "pinned"
}
}
Field |
Type |
Description |
|---|---|---|
|
string |
OK on success; HTTP status is 200. |
|
string |
OK on success. |
|
string |
Operation result: pinned, unpinned, or deleted. |
Error responses¶
Error formats and result confirmation distinguishes session-detail not-found from generic service errors at other entry points.