POST api/v2.0/Messaging/SendMessageToContact

Sends a new Message to the specified Contact.

Request Information

URI Parameters

None.

Body Parameters

Parameters that define the message to send and the contact to whom to send the message

SendMessageToContactRequest
NameDescriptionTypeAdditional information
ContactKey

globally unique identifier

None.

Subject

string

Required

Min length: 1

Body

string

Required

Min length: 1

Request Formats

application/json, text/json

Sample:
{
  "ContactKey": "e2bdb9cf-5345-4276-b055-cd4e4fea0ada",
  "Subject": "sample string 2",
  "Body": "sample string 3"
}

application/xml, text/xml

Sample:
<SendMessageToContactRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Request">
  <Body>sample string 3</Body>
  <ContactKey>e2bdb9cf-5345-4276-b055-cd4e4fea0ada</ContactKey>
  <Subject>sample string 2</Subject>
</SendMessageToContactRequest>

Response Information

Resource Description

True if message sent successfully, false otherwise

Collection of boolean

Response Formats

application/json, text/json

Sample:
[
  true,
  true
]

application/xml, text/xml

Sample:
<ArrayOfboolean xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <boolean>true</boolean>
  <boolean>true</boolean>
</ArrayOfboolean>