API: Rest Create Contact
The Create Contact command allows you to add a new Contact and set the related Contact an Custom Data. See REST API Contacts Overview for a table of Contact data available to POST.
To create a new Subscriber and a Subscription to a list at the same time, use Create Subscriber and List Subscription.
POST /subscribers
https://[siteurl]/rest/subscribers
Request Body Parameters
The Create Contact command requires the following in the Posted JSON:
- Email Address: "email": "[email]"
All other POST-able fields are optional, and can be found in the Data Fields table in REST API Contacts Overview.
To create a Contact in a Customer Key enabled Realm, you must also include the Customer Key in the JSON:
- Customer Key: "customerKey": "[customerKey]"
Request Body Example
Using Create Contact with all arguments, line breaks in JSON for readability:
curl --request POST \--url 'https://mail.mydomain.com/rest/subscribers' \
--header 'authorization: Basic bXlBY2NvdW50Onh5enB3ZDEyMw==' \
--header 'content-type: application/json' \
--header 'accept: application/vnd.whatcounts-v1+json' \
--data '{ "email": "jon.doe@mydomain.com", "firstName": "Jon", "lastName": "Doe", "company": "My Company", "address1": "123 Some Street North", "address2": "Suite 500", "city": "My City", "state": "WA", "zip": "98000", "country": "United States", "phone": "(206) 555 1212", "fax": "",
"publishingFlightId": "25", "customData": { "text": "text", "unicode": "unicode text", "large": "big", "number": 12, "float": 12.12, "date": "2016-07-04" } }' \
--include
Response Body
The response returns all API available Contact and Custom Data in JSON format. Blank data fields are not returned. Based on the example above, the response returns:
HTTP/1.1 200 OK Server: serverName Content-Type: application/json Content-Length: 926 Link: <https://mail.mydomain.com/rest/subscribers>; Date: Fri, 17 Jun 2016 12:54:44 GMT { "subscriberId": 7160984 "realmId": 1561 "email": "jon.doe@mydomain.com" "firstName": "Jon" "lastName": "Doe" "company": "My Company" "address1": "123 Some Street North" "address2": "Suite 500" "city": "My City" "state": "WA" "zip": "98000" "country": "United States" "phone": "(206) 555 1212" "fax": """publishingFlightId": "25" "createdDate": "May 21, 2012 9:14:16 AM" "updatedDate": "Nov 2, 2015 10:31:27 AM" "ipAddress": "" "md5Encryption": "C8ADED17D5F088E8262BF31ED933B7D4" "sha1Encryption": "356B1860247728C81486A35062688F302D96C2D1" "customData": { "text": "text" "unicode": "unicode text" "large": "big" "number": 12 "float": 12.12 "date": "2016-07-04" }, "skip": 1 "max": 0 }
Error Response
Error Response Codes include both Client Errors (4xx) and Server Errors (5xx). Descriptions of each can be found in Response Codes.
For example, if the required Email Address is missing, the error would appear as:
{ "error": "The Email field must be at least 5 characters long" "status": "Internal Server Error" "statusCode": 500 }*Publishing Flight added in v16.16