Update Notification Message

• Messages

Client API to update message by Id

Request

URI

PATCH

https://stg.skyscraper.vmware.com/api/notification/{orgId}/messages/{id}

COPY

Path Parameters

string

orgId

Required

Org ID

string

id

Required

Message ID

---

Request Body

MessagePatchStatusRequest of type(s) application/json

Required

{
    "status": "string"
}

string

status

Required

status

Possible values are : UNREAD, READ,

Authentication

This operation uses the following authentication methods.

BearerTokenAuth

Responses

200

Hide Details

OK

Returns MessageResponse of type(s) application/json

"MessageResponse Object"

string As date-time As date-time

created

Optional

The creation date of entity.

string As date-time As date-time

updated

Optional

The update date of entity.

integer As int32 As int32

version

Optional

Version of this entity.

string As uuid As uuid

id

Optional

Unique ID for this entity.

string

title

Required

Title of Subject of the message

string

content

Required

The message information

string As uuid As uuid

user_id

Optional

The user which will receive the message

string

user_type

Optional

user_type

Possible values are : END_USER, WEB_HOOK, FIELD_ENG, LINT,

string As uuid As uuid

template_id

Required

The template used for this message

string

external_message_id

Optional

The returned Id from the provider which processes the message, currently is used only for AWS SES

string

email

Optional

Users' email. This email is also email that user is going to recieve the notifications

string

omnichannel

Required

omnichannel

Possible values are : EMAIL, VMC_UI, VCENTER, WEBHOOK, LINT,

string

status

Required

status

Possible values are : UNREAD, READ,

string

state

Required

state

Possible values are : NOT_SEND, SENDING, CONFIRMED, FAILED, CANCELED,

array of string

visual_components

Optional

Constraints: minItems: 1 maxItems: 2147483647

visual_components

Possible values are : APP_BANNER, RESOURCE_PAGE_HEADER, RESOURCE_CARD,

array of string

cc

Optional

cc

array of string

bcc

Optional

bcc

object

metadata

Optional

Metadata that needs upon Message sending.

string As uuid As uuid

notification_id

Required

The message notification id.

string As uuid As uuid

resource_id

Optional

The resource id of the notification.

string

resource_type

Optional

resource_type

Possible values are : SDDC, ORG, VM, NAMESPACE, FLEX_SPACE,

string

priority

Optional

priority

Possible values are : CRITICAL, WARNING, INFORMATION, ERROR, SUCCESS,

string As date-time As date-time

expiry_date

Optional

Timestamp when the message will expire(valid only for VMCUI channel)

string

provider

Optional

The deployment type - AWS, Outpost, vSphere, Dimension and CFC

string As uuid As uuid

org_id

Optional

The org id of message.

400

Hide Details

Bad Request

Returns ErrorResponse of type(s) application/json

"ErrorResponse Object"

object

messages

Optional

Message of Error

string

type

Optional

type

401

Hide Details

Unauthorized

Returns MessageResponse of type(s) application/json

"MessageResponse Object"

string As date-time As date-time

created

Optional

The creation date of entity.

string As date-time As date-time

updated

Optional

The update date of entity.

integer As int32 As int32

version

Optional

Version of this entity.

string As uuid As uuid

id

Optional

Unique ID for this entity.

string

title

Required

Title of Subject of the message

string

content

Required

The message information

string As uuid As uuid

user_id

Optional

The user which will receive the message

string

user_type

Optional

user_type

Possible values are : END_USER, WEB_HOOK, FIELD_ENG, LINT,

string As uuid As uuid

template_id

Required

The template used for this message

string

external_message_id

Optional

The returned Id from the provider which processes the message, currently is used only for AWS SES

string

email

Optional

Users' email. This email is also email that user is going to recieve the notifications

string

omnichannel

Required

omnichannel

Possible values are : EMAIL, VMC_UI, VCENTER, WEBHOOK, LINT,

string

status

Required

status

Possible values are : UNREAD, READ,

string

state

Required

state

Possible values are : NOT_SEND, SENDING, CONFIRMED, FAILED, CANCELED,

array of string

visual_components

Optional

Constraints: minItems: 1 maxItems: 2147483647

visual_components

Possible values are : APP_BANNER, RESOURCE_PAGE_HEADER, RESOURCE_CARD,

array of string

cc

Optional

cc

array of string

bcc

Optional

bcc

object

metadata

Optional

Metadata that needs upon Message sending.

string As uuid As uuid

notification_id

Required

The message notification id.

string As uuid As uuid

resource_id

Optional

The resource id of the notification.

string

resource_type

Optional

resource_type

Possible values are : SDDC, ORG, VM, NAMESPACE, FLEX_SPACE,

string

priority

Optional

priority

Possible values are : CRITICAL, WARNING, INFORMATION, ERROR, SUCCESS,

string As date-time As date-time

expiry_date

Optional

Timestamp when the message will expire(valid only for VMCUI channel)

string

provider

Optional

The deployment type - AWS, Outpost, vSphere, Dimension and CFC

string As uuid As uuid

org_id

Optional

The org id of message.

403

Hide Details

Forbidden

Returns MessageResponse of type(s) application/json

"MessageResponse Object"

string As date-time As date-time

created

Optional

The creation date of entity.

string As date-time As date-time

updated

Optional

The update date of entity.

integer As int32 As int32

version

Optional

Version of this entity.

string As uuid As uuid

id

Optional

Unique ID for this entity.

string

title

Required

Title of Subject of the message

string

content

Required

The message information

string As uuid As uuid

user_id

Optional

The user which will receive the message

string

user_type

Optional

user_type

Possible values are : END_USER, WEB_HOOK, FIELD_ENG, LINT,

string As uuid As uuid

template_id

Required

The template used for this message

string

external_message_id

Optional

The returned Id from the provider which processes the message, currently is used only for AWS SES

string

email

Optional

Users' email. This email is also email that user is going to recieve the notifications

string

omnichannel

Required

omnichannel

Possible values are : EMAIL, VMC_UI, VCENTER, WEBHOOK, LINT,

string

status

Required

status

Possible values are : UNREAD, READ,

string

state

Required

state

Possible values are : NOT_SEND, SENDING, CONFIRMED, FAILED, CANCELED,

array of string

visual_components

Optional

Constraints: minItems: 1 maxItems: 2147483647

visual_components

Possible values are : APP_BANNER, RESOURCE_PAGE_HEADER, RESOURCE_CARD,

array of string

cc

Optional

cc

array of string

bcc

Optional

bcc

object

metadata

Optional

Metadata that needs upon Message sending.

string As uuid As uuid

notification_id

Required

The message notification id.

string As uuid As uuid

resource_id

Optional

The resource id of the notification.

string

resource_type

Optional

resource_type

Possible values are : SDDC, ORG, VM, NAMESPACE, FLEX_SPACE,

string

priority

Optional

priority

Possible values are : CRITICAL, WARNING, INFORMATION, ERROR, SUCCESS,

string As date-time As date-time

expiry_date

Optional

Timestamp when the message will expire(valid only for VMCUI channel)

string

provider

Optional

The deployment type - AWS, Outpost, vSphere, Dimension and CFC

string As uuid As uuid

org_id

Optional

The org id of message.

404

Hide Details

Not Found

Returns ErrorResponse of type(s) application/json

"ErrorResponse Object"

object

messages

Optional

Message of Error

string

type

Optional

type

500

Hide Details

Internal Server Error

Returns ErrorResponse of type(s) application/json

"ErrorResponse Object"

object

messages

Optional

Message of Error

string

type

Optional

type

Code Samples

COPY

                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"status:"string"}'
                

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Messages Operations

GET

Get Message

PATCH

Update Notification Message

GET

Get User Messages