Send Message with Customer Key

The Send Message with Customer Key command allows you to send a single transactional style message to a Contact in a Customer Key enabled realm. 

Messages are individually created and sent but can be tracked together as a sticky campaign to collect data as a single campaign.  To group your data into a single campaign, either use the Campaign Name argument or use a List with Sticky Campaigns enabled. 

This command does not support the same features as the HTTP API, FTP API, or WebServices API Send commands, including the ability to define Google Analytics strings, Account Profile, or Contact Data for personalization.  

If your content includes Contact or Custom Data, use the Send Message with Contact Model and Names or Contact Model and IDs.  

To send to a Contact in a non Customer Key enabled Realm, use the Send Message command.

POST /msg


The following queries are supported:

format=[1,2,99], where 1=plain text, 2=html, and 99=MIME

To track one-off message events, such as opens and click-throughs, define a campaign name. The Campaign Name can be no longer than 100 characters. A single list can have multiple campaigns by defining a different Campaign Name in a command.

If a contact has opted out, messages sent via the Send command will not be delivered. To override this restriction for transactional messages, such as order confirmations, set this argument to 'false'. DO NOT override opt outs for anything other than transactional messages, as this could be construed as spam.

If Email Snapshot is enabled for a realm, the snapshot flag provides the ability to save and store HTML and PNG screenshots of emails.  To store a snapshot, set this argument to '1'. 

Request Body Parameters

The Send Message with Customer Key command requires the URI call with the List Name, Template Name, Contact Customer Key. Other Filters include Format, Campaign Name, Email Snapshot, and Opt Out parameters. 

The query strings are case sensitive and must be defined as in the example.  If the query string is incorrect or missing, it is ignored and the command creates a Plain Text message without duplication, sending to the first contact found to match the posted JSON. 

Request Body Example

Using Send Message with Customer Key with all arguments, line breaks in JSON for readability:

curl --request POST \ 
--url '' \
--header 'authorization: Basic bXlBY2NvdW50Onh5enB3ZDEyMw==' \
--header 'content-type: application/json' \
--header 'accept: application/vnd.whatcounts-v1+json' \

Response Body

The response returns a Success or Failure Error.  Based on the first example above, the response returns a 0 for Success:

HTTP/1.1 200 OK
Server: serverName
Content-Type: application/json
Content-Length: 1
Date: Fri, 17 Mar 2018 12:54:44 GMT

Error Response

Error Response Codes include both Client Errors (4xx) and Server Errors (5xx).  Descriptions of each can be found in Response Codes.  An error will occur if List, Template, or Contact are not found.

For example, if a Subscription does not exist for the Contact, the error would appear as:

"error": "Subscriber Not Found"
"status": "Not Found"
"statusCode": 404

Feature added in v13.00.0, Email Snapshot added in v15.00.00

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request


Powered by Zendesk