Modify Notification Details

PATCH /client/notifications/{id}/

Use the PATCH /client/notifications/{id}/ endpoint to update the details of an existing notification. You can modify the notification's header, body, and optional image URL using the unique id of the notification.

Parameters

Path Parameter:

Name
Type
In
Description
Required

id

integer

path

A unique integer value identifying the notification.

Yes

Request Body:

Name
Type
Description
Required

header

string

The header of the notification.

Yes

body

string

The body content of the notification.

Yes

image

string

An optional URL for the notification image.

No

Example Request Body:

{
  "header": "Updated Notification Title",
  "body": "This is the updated content of the notification.",
  "image": "https://example.com/new-image.jpg"
}

Responses

200 OK

Description: The notification details were successfully updated.

Example Response:

{
  "id": 101,
  "header": "Updated Notification Title",
  "body": "This is the updated content of the notification.",
  "image": "https://example.com/new-image.jpg",
  "created_at": "2024-11-17T10:30:00Z",
  "created_by": "System"
}

Last updated