Sign in
Notifications

Update notification

Update notification.

patch/v1/notifications/inbox/{notificationId}

Path parameters

notificationIdstring required

ID of the notification.

Request body

status'READ' | 'UNREAD' | 'ARCHIVED' required

Status of the notification.

Response

View a single notification.

idstring uuid required

Contains a unique identifier used for this resource.

titlestring required
descriptionstring required
status'READ' | 'UNREAD' | 'ARCHIVED' required

Status of the notification.

region'US' | 'EU' | 'AU' | 'ME' | 'IN' | '*' required

Region associated to a notification.

namespace'plan-and-usage' | 'organization' | 'dev-portal' | 'cloud-gateways' | 'gateway-manager' required
entity_idstring required

ID of the entity. Use '*' to represent all entities of this type.

detailsobject required

Metadata associated with the notification to build actionable links.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

Changed in 3 of the 75 revisions of this API.93

  • 8ab3ec3ed3011See the full diff
    • ●

      added the new type enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

  • 3c0154b2053a9See the full diff
    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterChoiceItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterDependentItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMaximumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property detail became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property instance became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property status became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property title became nullable for the status 401

      response-property-became-nullable

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 87c135153b842See the full diff
    • ●

      added the new cloud-gateways enum value to the namespace response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new gateway-manager enum value to the namespace response property for the response status 200

      response-property-enum-value-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog