PUT User Status
Overview
The following table contains important information about the PUT method in regards to changing the status of a user notification.
| PUT Change Status | |
|---|---|
| Method | PUT |
| URL or Endpoint | /api/organizations/organizationId/user-notifications/id/status |
| Headers | Authorization |
| Parameters | id, organizationId, api-version |
| Body | Not applicable. |
The description of the URL parameter is as follows:
| Parameter Name | Mandatory | Type | Description |
|---|---|---|---|
| id | Yes | string | Unique Id. |
| organizationId | Yes | string | Unique Id of the organization. |
| api-version | No | string | The correct api version to use. |
Response
{
"success": true,
"errors": [
"string"
],
"messages": [
"string"
],
"result": true,
"resultInfo": "string",
"statusCode": 0
}
Information about the fields that appear when you receive the response are displayed in the table below.
| Field Name | Type | Description |
|---|---|---|
| success | bool | If the response is successful it will return true. Otherwise will return false. |
| errors | array[] | Indicates if there was an error. |
| messages | array[] | Returns the response message from back-end. |
| result | array[Object] | Returns the response object. |
| resultInfo | string | Returns extra information about the result. |
| statusCode | integer($int32) | Returns the HTTP Status Code. |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed