PUT v1/Customers/{customerId}/PushMessage

Send a push message to an AO Customer

URI template

v1/Customers/{customerId}/PushMessage

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerId

Customer Id of the target AO Customer

globally unique identifier

Required

Body Parameters

Push Message content

InPushMessageContent
NameDescriptionTypeAdditional information
Message

The message string to be sent in the push message

string

Required

Request Formats

application/json, text/json

Sample:
{
  "Message": "sample string 1"
}

application/xml, text/xml

Sample:
<InPushMessageContent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Inbound">
  <Message>sample string 1</Message>
</InPushMessageContent>

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.