[HTTP PATCH] ~/journeys/sendTextMessage

Description: Create/Update a contact in a specific ContactList and send an email to the contact.

Request Information

URI Parameters

None.

QueryString Parameters

Match Values

This Endpoint supports updating all Contacts within a given ContactList who have properties that match a given set values.

You can specify what values to match on by adding the following to the Request's QueryString:

  • Adding 'match' parameter with a comma-seperated list of the PropertyNames to match on.
  • If using a PATCH call - by Adding each PropertyName and required value to match upon.
  • If using a POST/PUT call, make sure the specified PropertyName is a property of the ContactDTO that's being passed as part of the body.

For Example: If you'd like to update all contacts who have a specific ReferanceAccountId and EmailAddress, you would do so via:

[PATCH] journeys/sendTextMessage + "?match=ReferanceAccountId,Email&ReferanceAccountId=123456&Email=pgannon@customerminds.com"

[PUT] journeys/sendTextMessage + "?match=ReferanceAccountId,Email"
Body: {
  values: {
    "ReferanceAccountId":123456,
    "Email": "pgannon@customerminds.com"
    "Mobile": "353871234567" // Value to be updated
  }
}

Please refer to the given ContactList's Schema/Fields as a list of valid values.

Body Parameters

SendTextMessageRequestDTO
NameDescriptionTypeAdditional information
TextMessageId

The name of the TextMessage to send

 integer

None.
Contact

The Contact information to use for the TextMessage

 Contact

None.

Formats

application/json, text/json

Sample: 
{
  "TextMessageId": 1,
  "Contact": {
    "EncContactId": "sample string 2",
    "ListId": 3,
    "Values": {
      "sample string 1": {},
      "sample string 3": {}
    }
  }
}

application/csp-report

Sample: 
{"TextMessageId":1,"Contact":{"EncContactId":"sample string 2","ListId":3,"Values":{"sample string 1":{},"sample string 3":{}}}}

application/xml, text/xml

Sample: 
<SendTextMessageRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO">
  <Contact>
    <EncContactId xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">sample string 2</EncContactId>
    <Id xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">1</Id>
    <ListId xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">3</ListId>
    <Values xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
    </Values>
  </Contact>
  <TextMessageId>1</TextMessageId>
</SendTextMessageRequestDTO>

Response Information

Description

Successful Response - OK (200):

Sends the specified Journey email to the to the contact

Response Content : 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.

Response Codes: