Skip to main content
PATCH
/
v1
/
notifications
/
{id}
/
toggle-status
Toggle notification status
curl --request PATCH \
  --url https://staging.api.us.aptlydone.com/notification/v1/notifications/{id}/toggle-status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "READ"
}
'
{
  "statusCode": 200,
  "timestamp": "2025-06-24T08:51:23.434Z",
  "message": "Success",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440002",
    "tenantId": "123e4567-e89b-12d3-a456-426614174000",
    "templateKey": "DELEGATION_ISSUED",
    "category": "Delegations",
    "title": "Delegation Issued",
    "message": "Delegation ABC123 was issued to you. Click to review.",
    "isActionable": true,
    "status": "UNREAD",
    "createdAt": "2023-01-01T12:00:00Z",
    "userId": "550e8400-e29b-41d4-a716-446655440000",
    "entityType": "delegation",
    "entityId": "123456",
    "relativeTime": "2 hours ago",
    "readAt": "2023-01-02T14:30:00Z",
    "actionUrl": "https://example.com/delegations/123456",
    "payload": {
      "assignedBy": "John Doe",
      "priority": "high"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
status
enum<string>

The specific status to set (optional)

Available options:
UNREAD,
READ
Example:

"READ"

Response

200 - application/json

Notification status toggled successfully

​
statusCode
number
required

HTTP Status code

Example:

200

​
timestamp
string
required

Timestamp of the response

Example:

"2025-06-24T08:51:23.434Z"

​
message
string
required

Response message

Example:

"Success"

​
data
object
required

Response data