Examples below include;

 

Retrieve 360 Project
Retrieve 360 Inbound Connection
Submit Contact Data to 360 Inbound Connection
Retrieve 360 Outbound Connection
Retrieve 360 Outbound Contact
Delete 360 Outbound Contact
Get Current Server Date/Time
Add to Suppression List
Retrieve All Contact Lists
Create Contact List
Retrieve Single Contact List
Modify Contact List
Delete Contact List
Retrieve All Contacts
Create New Contact
Retrieve a Single Contact
Modify Contact
Delete Contact
Batch Upload Contacts
Get Batch Contact Upload Status

 

 

 

Retrieve 360 Project

GET crossmarketer/{id}

Description

This method will return the 360 project with attached API connections.

Response Body

The response will deliver the 360 project data along with all available API connections.

XML Example:

<?xml version="1.0" encoding="UTF-8"?>

<project id="919" active="1">

<id>919</id>

<name>A 360 Project</name>

<active>1</active>

<link rel="self" href="/{API_URL}/crossmarketer/919"/>

<connections count="2">

<connection id="1" type="in" active="1">

   <id>1</id>

   <name>In</name>

   <type>in</type>

   <active>1</active>

   <link rel="self" href="/{API_URL}/crossmarketer/919/inbound/1"/>

</connection>

<connection id="2" type="out" active="1">

   <id>2</id>

   <name>Out</name>

   <type>out</type>

   <active>1</active>

   <link rel="self" href="/{API_URL}/crossmarketer/919/outbound/2"/>

</connection>

</connections>

</project>

JSON Example:

{

"project":{

   "id":"919",

   "name":"A 360 Project",

   "active":1,

   "connections":{

     "1":{

       "id":"1",

       "type":"in",

       "name":"In",

       "active":1,

       "@link":{

         "rel":"self",

         "href":"{{API_URL}}\/crossmarketer\/919\/inbound\/1"

       }

     },

     "2":{

       "id":"2",

       "type":"out",

       "name":"Out",

       "active":1,

       "@link":{

         "rel":"self",

         "href":"{{API_URL}}\/crossmarketer\/919\/outbound\/2"

       }

     }

   },

   "@link":{

     "rel":"self",

     "href":"{{API_URL}}\/crossmarketer\/919"

   }

}

}

 

 

 

Retrieve 360 Inbound Connection

GET crossmarketer/{id}/inbound/{connection_id}

Description

This method will return information about an inbound API connection.

Response Body

The response will deliver information about the inbound API connection..

XML Example:

<?xml version="1.0" encoding="UTF-8"?>

<connection id="1" active="1">

<id>1</id>

<name>In</name>

<active>1</active>

<link rel="self" href="/{{API_URL}}/crossmarketer/919/inbound/1"/>

</connection>

JSON Example:

{

"connection":{

   "id":"1",

   "type":"in",

   "name":"In",

   "active":1,

   "@link":{

     "rel":"self",

     "href":"{{API_URL}}\/crossmarketer\/919\/inbound\/1"

   }

}

}

 

 

Submit Contact Data to 360 Inbound Connection

POST crossmarketer/{id}/inbound/{connection_id}

Description

This method allows data in the form of an individual contact or a full list to be submitted for processing by a 360 Inbound Connection.

Request Body

The request can contain either an individual contact (row) or a list. This will be the contact or list that will be taken into the 360 inbound connection and processed by the 360 Project.

XML Example:

<!-- Trigger the 360 using a list -->

<list>

<list>1</list>

</list>

<!-- Trigger the 360 using a contact -->

<row>

<list>1</list>

<row>3</row>

</row>

JSON Example:

// Trigger the 360 using a list

{"list":{"list":1}}

// Trigger the 360 using a contact

{"row":{"list":1, "row":3}}

 

 

 

Retrieve 360 Outbound Connection

GET crossmarketer/{id}/outbound/{connection_id}

Description

This method will return information about an outbound API connection and a short list of contacts/lists.

Request Body

The request can optionally be made using showprocessed to show contacts that have already been processed.

XML Example:

<settings>

<showprocessed>1</showprocessed>

</settings>

JSON Example:

{

"settings": {

   "showprocessed": 1

}

}

Response Body

The response will deliver information about the inbound API connection.

XML Example:

<?xml version="1.0" encoding="UTF-8"?>

<connection id="2" active="1">

<id>2</id>

<name>Out</name>

<type>out</type>

<active>1</active>

<link rel="self" href="/{API_URL}/crossmarketer/919/outbound/2"/>

<contacts count="3">

<contact id="1" type="list" processed="1">

   <id>1</id>

   <type>list</type>

   <list>1</list>

   <links>

   <link rel="self" href="/{API_URL}/crossmarketer/919/outbound/2/1"/>

   <link rel="list" href="/{API_URL}/core/contactlists/1"/>

   </links>

</contact>

<contact id="4" type="list" processed="1">

   <id>4</id>

   <type>list</type>

   <list>1</list>

   <links>

   <link rel="self" href="/{API_URL}/crossmarketer/919/outbound/2/4"/>

   <link rel="list" href="/{API_URL}/core/contactlists/1"/>

   </links>

</contact>

<contact id="6" type="row" processed="0">

   <id>6</id>

   <type>row</type>

   <list>1</list>

   <row>3</row>

   <links>

   <link rel="self" href="/{API_URL}/crossmarketer/919/outbound/2/6"/>

   <link rel="contact" href="/{API_URL}/core/contactlists/1/contacts/3"/>

   </links>

</contact>

</contacts>

</connection>

JSON Example:

{

"connection":{

     "id":"2",

     "type":"out",

     "name":"Out",

     "active":1,

     "contacts":{

         "6":{

             "id":"6",

             "type":"row",

             "processed":0,

             "created":1376486589,

             "links":{

                 "self":{

                     "@link":{

                         "rel":"self",

                         "href":"{API_URL}\/crossmarketer\/919\/outbound\/2\/6"

                     }

                 },

                "row":{

                     "@link":{

                         "rel":"contact",

                         "href":"{API_URL}\/core\/contactlists\/1\/contacts\/3"

                     }

                 }

             },

             "list":"1",

             "row":3

         }

     },

     "@link":{

         "rel":"self",

         "href":"{API_URL}\/crossmarketer\/919\/outbound\/2"

     }

}

}

 

 

Retrieve 360 Outbound Contact

GET crossmarketer/{id}/outbound/{connection_id}/{contact_id}

Description

This method will return information a resource with an associated list/contact along with links to the specific contact/list, and a link to the next and previous resource in the chain.

Request Body

The request can optionally be made using showprocessed to show contacts that have already been processed. This only affects the next and previous references.

XML Example:

<settings>

<showprocessed>1</showprocessed>

</settings>

JSON Example:

{

"settings": {

   "showprocessed": 1

}

}

Response Body

The response will deliver information about the contact/list, and a link to the next and previous resource in the chain.

XML Example:

<?xml version="1.0" encoding="UTF-8"?>

<contact id="6" type="row" processed="1">

<id>6</id>

<type>row</type>

<list>1</list>

<row>3</row>

<links>

<link rel="self" href="/{API_URL}/crossmarketer/919/outbound/2/6"/>

<link rel="previous" href="/{API_URL}/crossmarketer/919/outbound/2/4"/>

<link rel="contact" href="/{API_URL}/core/contactlists/1/contacts/3"/>

</links>

</contact>

JSON Example:

{

"contact":{

     "id":"6",

     "type":"row",

     "processed":1,

     "created":1376486589,

     "links":{

         "self":{

             "@link":{

                 "rel":"self",

                 "href":"{API_URL}\/crossmarketer\/919\/outbound\/2\/6"

             }

         },

         "previous":{

             "@link":{

                 "rel":"previous",

                 "href":"{API_URL}\/crossmarketer\/919\/outbound\/2\/4"

             }

         },

          "row":{

             "@link":{

                 "rel":"contact",

                 "href":"{API_URL}\/core\/contactlists\/1\/contacts\/3"

             }

         }

     },

     "list":"1",

     "row":3

}

}

 

 

Delete 360 Outbound Contact

DELETE crossmarketer/{id}/outbound/{connection_id}/{contact_id}

Description

This method removes the contact/list from the processing queue so that it will no longer appear. This does not delete the contact/list. It is recommended this is done after successfully processing the contact/list in order to keep the queue straightforward and current.

 

 

 

Get Current Server Date/Time

GET core/date

Description

Get the current date/time of the server in ISO-8601 format. The time will be adjusted to GMT. This is useful for the authentication process.

Response Body

The response will contain the current server date/time.

XML Example:

<?xml version="1.0" encoding="UTF-8"?>

<date>Thu, 15 Nov 2012 21:52:33 +0000</date>

JSON Example:

{

"date" : "Thu, 15 Nov 2012 21:52:33 +0000"

}

 

 

Add to Suppression List

POST core/suppression/email

POST core/suppression/phone

POST core/suppression/mobile

POST core/suppression/fax

Description

Add one or more items to a suppression list. There are four different suppression lists that you can add to: email, phone, mobile, and fax. The type of list you want to is indicated by the request URI (see above). Once a phone number or email address is added to these lists, our system will no longer send to it.

Request Body

A request expects a collection of one or more entries to add to the suppression list.

XML Example:

<?xml version="1.0" encoding="UTF-8"?>

<suppressionEntries>

<entry>This email address is being protected from spambots. You need JavaScript enabled to view it.<';document.getElementById('cloak62d7d044aebdc77dc836ef4d9709b7ce').innerHTML += ''+addy_text62d7d044aebdc77dc836ef4d9709b7ce+'<\/a>'; ;/entry>

</suppressionEntries>

JSON Example:

{

"suppressionEntries": [

   "19025556451",

   "15552145146"

]

}

Response Body

The response will contain the an entry for each value added to the suppression list, and the date it was added (may be in the past if the entry already existed.

XML Example:

<?xml version="1.0" encoding="UTF-8"?>

<suppressionEntries>

<entry added="2014-06-03T14:22:04+00:00">This email address is being protected from spambots. You need JavaScript enabled to view it.<';document.getElementById('cloak51006f8e739ee2c0ef104520f7066762').innerHTML += ''+addy_text51006f8e739ee2c0ef104520f7066762+'<\/a>'; ;/entry>

</suppressionEntries>

JSON Example:

{

"suppressionEntries":[

   {"entry":"+19025556451", "added":"2014-06-03T14:22:29+00:00"},

   {"entry":"+15552145146", "added":"2014-06-03T14:22:31+00:00"}

]

}

 

 

Retrieve All Contact Lists

GET core/contactlists/

Description

This method will return a collection containing all of the lists for the authenticated user. A maximum of 100 lists will be returned in a single call; use the query parameters to modify the page size and offset.

Response Body

The response will contain a collection of contact lists. Each list entry in the collection will have an ID, name and a link to the relevant resource.

XML Example:

<?xml version="1.0" encoding="UTF-8"?>

<contactLists>

<contactList id="4003004">

   <link rel="self" href="/{API_URL}/core/contactlists/4003004" />

   <name>My List 1</name>

</contactList>

<contactList id="1001001">

   <link rel="self" href="/{API_URL}/core/contactlists/1001001" />

   <name>My List 2</name>

</contactList>

</contactLists>

JSON Example:

{

"contactLists": {

   "4003004": {

     "name": "My List 1",

     "@link": {"rel": "self", "href": "{API_URL}/core/contactlists/4003004" }

   },

   "1001001" : {

     "name": "My List 2",

     "@link": {"rel": "self", "href": "{API_URL}/core/contactlists/1001001" }

   }

}

}

 

 

Create Contact List

POST core/contactlists/

Description

This method will create a single new contact list.

Request Body

List names are optional. A default name will be used if one is not provided.

XML Example:

<?xml version="1.0" encoding="UTF-8"?>

<contactList>

<name>My New List</name>

</contactList>

JSON Example:

{

"contactList": {

   "name": "My New List",

}

}

Response Body

The response will print the data in the created list, plus the ID of the list and a link to the list resource.

XML Example:

<?xml version="1.0" encoding="UTF-8"?>

<contactList id="1001001">

<name>My New List</name>

<link rel="self" href="/{API_URL}/core/contactlists/1001001" />

</contactList>

JSON Example:

{

"contactList": {

   "id": "1001001",

   "@link": {"rel": "self", "href": "{API_URL}/core/contactlists/1001001" },

   "name": "My New List",

}

}

 

 

Retrieve Single Contact List

GET core/contactlists/{id}

Description

This method will get information about the contact list specified in the request URI, including the list name and the columns on the list.

Response Body

The response data will contain information about the contact list, including properties such as the name of the list and the columns in the list.

XML Example:

<?xml version="1.0" encoding="UTF-8"?>

<contactList id="1001001" size="5">

<name>My New List</name>

<link rel="self" href="/{API_URL}/core/contactlists/1001001" />

</contactList>

JSON Example:

{

"contactList": {

   "id": "1001001",

   "size": "5",

   "@link": {"rel": "self", "href": "{API_URL}/core/contactlists/1001001" },

   "name": "My New List",

}

}

 

 

Modify Contact List

POST core/contactlists/{id}

Description

Use this method to modify the properties of a list, in whole or in part. If the list does not exist, it will not be created by calling this function. To modify columns, use the /core/contactlists/{id}/columns/{columnId} resources.

Request Body

Supply a contact list resource with the properties to change. Currently, this is only the name property.

XML Example:

<?xml version="1.0" encoding="UTF-8"?>

<contactList>

<name>New List Name Foo</name>

</contactList>

JSON Example:

{

"contactList": {

   "name": "New List Name Foo"

}

}

Response Body

The representation of the list in its new state is returned.

XML Example:

<?xml version="1.0" encoding="UTF-8"?>

<contactList id="1001001">

<name>New List Name Foo</name>

<link rel="self" href="/{API_URL}/core/contactlists/1001001" />

<columns>

   <link rel="self" href="/{API_URL}/core/contactlists/1001001/columns" />

   <column id="6" type="email">

     <name>Email</name>

     <link rel="self" href="/{API_URL}/core/contactlists/1001001/columns/6" />

   </column>

   <column id="7">

     <name>Last Name</name>

     <link rel="self" href="/{API_URL}/core/contactlists/1001001/columns/7" />

   </column>

   <column id="8" type="fax">

     <name>Fax</name>

     <link rel="self" href="/{API_URL}/core/contactlists/1001001/columns/8" />

   </column>

</columns>

</contactList>

JSON Example:

{

"contactList": {

   "id": "1001001",

   "@link": {"rel": "self", "href": "{API_URL}/core/contactlists/1001001" },

   "name": "New List Name Foo",

   "columns": {

     "@link": {"rel": "self", "href": "{API_URL}/core/contactlists/1001001/columns" },

     "6": {

       "type": "email",

        "name": "Email",

       "@link": {"rel": "self", "href": "{API_URL}/core/contactlists/1001001/columns/6" }

     },

     "7": {

       "name": "Last Name",

       "@link": {"rel": "self", "href": "{API_URL}/core/contactlists/1001001/columns/7" }

     },

     "8": {

       "type": "fax",

       "name": "Fax",

       "@link": {"rel": "self", "href": "{API_URL}/core/contactlists/1001001/columns/8" }

     }

   }

}

}

 

Delete Contact List

DELETE core/contactlists/{id}

Description

This method will permanently delete the specified contact list.

Response Body

No response body is specified; HTTP 204 No Content will be returned.

 

 

Retrieve All Contacts

 

GET core/contactlists/{id}/contacts

Description

This method will obtain a collection of contact information from the specified list.
At most, 100 contacts will be returned. The paging parameters ‘offset’ and ‘limit’ may
be used to access different parts of the collection.

The deletion of records will almost certainly change the contents of the pages that
follow the removed record, which may cause issues for iterating through contacts. Be sure
to use the ‘next’ link relation data or overlapping pages to confirm integrity of the
collection.

Response Body

The response will contain a collection of contacts. Each contact representation will have all information stored about that client. Modified date format is compliant to ISO-8601.

XML Example:

<?xml version="1.0" encoding="UTF-8"?>

<contacts>

<link rel="next" href="/{API_URL}/core/contactlists/{listId}/contacts?offset=8&amp;limit=3" />

<contact id="5" modifiedDate="2012-08-15T15:52:01-0400">

   <link rel="self" href="/{API_URL}/core/contactlists/{listId}/contacts/5" />

   <link rel="next" href="/{API_URL}/core/contactlists/{listId}/contacts/6" />

   <link rel="prev" href="/{API_URL}/core/contactlists/{listId}/contacts/4" />

   <field id="email">This email address is being protected from spambots. You need JavaScript enabled to view it.<';document.getElementById('cloak0e0a8b2a6bf323b4e6061270c76b5990').innerHTML += ''+addy_text0e0a8b2a6bf323b4e6061270c76b5990+'<\/a>'; ;/field>

   <field id="mobile">1-555-555-1234</field>

   <field id="name">Jane Smith</field>

</contact>

<contact id="6" modifiedDate="2012-06-21T12:51:11-0400">

   <link rel="self" href="/{API_URL}/core/contactlists/{listId}/contacts/6" />

   <link rel="next" href="/{API_URL}/core/contactlists/{listId}/contacts/7" />

   <link rel="prev" href="/{API_URL}/core/contactlists/{listId}/contacts/5" />

   <field id="email">This email address is being protected from spambots. You need JavaScript enabled to view it.<';document.getElementById('cloak0a5dfb16e851b5e49657ca1be513a767').innerHTML += ''+addy_text0a5dfb16e851b5e49657ca1be513a767+'<\/a>'; ;/field>

   <field id="mobile">1-555-555-4321</field>

   <field id="name">John Smith</field>

</contact>

<contact id="7" modifiedDate="2012-07-23T01:21:20-0400">

   <link rel="self" href="/{API_URL}/core/contactlists/{listId}/contacts/7" />

   <link rel="next" href="/{API_URL}/core/contactlists/{listId}/contacts/8" />

   <link rel="prev" href="/{API_URL}/core/contactlists/{listId}/contacts/6" />

   <field id="email">This email address is being protected from spambots. You need JavaScript enabled to view it.<';document.getElementById('cloak358996adbf60f9e92ee3d782936537d6').innerHTML += ''+addy_text358996adbf60f9e92ee3d782936537d6+'<\/a>'; ;/field>

   <field id="mobile">1-555-555-4312</field>

   <field id="name">Richard Smith</field>

</contact>

</contacts>

JSON Example:

{

"@link": {"rel": "next", "href": "{API_URL}/core/contactlists/{listId}/contacts?offset=8&limit=3"},

"contacts": {

   "5": {

     "modifiedDate": "2012-08-15T15:52:01-0400",

     "@links": [

       {"rel": "self", "href": "{API_URL}/core/contactlists/{listId}/contacts/5"},

       {"rel": "next", "href": "{API_URL}/core/contactlists/{listId}/contacts/6"},

       {"rel": "prev", "href": "{API_URL}/core/contactlists/{listId}/contacts/4"}

     ],

     "fields": {

       "email": {"value": "This email address is being protected from spambots. You need JavaScript enabled to view it."},

       "mobile": {"value": "1-555-555-1234"},

       "name": {"value": "Jane Smith"}

     }

   },

   "6": {

     "modifiedDate": "2012-06-21T12:51:11-0400",

     "@links": [

       {"rel": "self", "href": "{API_URL}/core/contactlists/{listId}/contacts/6"},

       {"rel": "next", "href": "{API_URL}/core/contactlists/{listId}/contacts/7"},

       {"rel": "prev", "href": "{API_URL}/core/contactlists/{listId}/contacts/5"}

     ],

     "fields": {

       "email": {"value": "This email address is being protected from spambots. You need JavaScript enabled to view it."},

       "mobile": {"value": "1-555-555-4321"},

       "name": {"value": "John Smith"}

     }

   },

   "7": {

     "modifiedDate": "2012-07-23T01:21:20-0400",

     "@links": [

       {"rel": "self", "href": "{API_URL}/core/contactlists/{listId}/contacts/7"},

       {"rel": "next", "href": "{API_URL}/core/contactlists/{listId}/contacts/8"},

       {"rel": "prev", "href": "{API_URL}/core/contactlists/{listId}/contacts/6"}

     ],

     "fields": {

       "email": {"value": "This email address is being protected from spambots. You need JavaScript enabled to view it."},

       "mobile": {"value": "1-555-555-4312"},

       "name": {"value": "Richard Smith"}

     }

   }

}

}

 

 

Create New Contact

POST core/contactlists/{id}/contacts

Description

This method will create a single contact on the given list. To create more than one contact at once, please use the resource /core/contactlists/{id}/contacts/batch/create.

Request Body

The request body should contain data for each field in the list. If any are missing, those fields will be left blank in the new record. For each field, explicitly provide the column ID that field maps to.

XML Example:

<?xml version="1.0" encoding="UTF-8"?>

<contact>

<field id="email">This email address is being protected from spambots. You need JavaScript enabled to view it.<';document.getElementById('cloakd5428cf428566733e342bd16142cfa63').innerHTML += ''+addy_textd5428cf428566733e342bd16142cfa63+'<\/a>'; ;/field>

<field id="mobile">1-555-555-1234</field>

<field id="name">John Smith</field>

</contact>

JSON Example:

{

"contact": {

   "fields": {

     "name": "This email address is being protected from spambots. You need JavaScript enabled to view it.",

     "mobile": "1-555-555-1234",

     "email": "John Smith"

   }

}

}

Response Body

The response will echo back the created data, along with the contact ID and navigational links.

XML Example:

<?xml version="1.0" encoding="UTF-8"?>

<contact id="10" modifiedDate="2012-08-15T15:52:01-04:00">

<link rel="self" href="/{API_URL}/core/contactlists/{listId}/contacts/10" />

<link rel="prev" href="/{API_URL}/core/contactlists/{listId}/contacts/9" />

<field id="email">This email address is being protected from spambots. You need JavaScript enabled to view it.<';document.getElementById('cloak2ee28f249790d71afa18acbf71096b65').innerHTML += ''+addy_text2ee28f249790d71afa18acbf71096b65+'<\/a>'; ;/field>

<field id="mobile">1-555-555-1234</field>

<field id="name">John Smith</field>

</contact>

JSON Example:

{

"contact": {

   "id": "10",

   "modifiedDate": "2012-08-15T15:52:01-04:00",

   "@links": [

     {"rel": "self", "href": "{API_URL}/core/contactlists/{listId}/contacts/10"},

     {"rel": "prev", "href": "{API_URL}/core/contactlists/{listId}/contacts/9"}

   ],

   "fields": {

     "email": {"value": "This email address is being protected from spambots. You need JavaScript enabled to view it."},

     "mobile": {"value": "1-555-555-1234"},

     "name": {"value": "John Smith"}

   }

}

}

Retrieve a Single Contact

GET core/contactlists/{id}/contacts/{id}

Description

This method will return field data from the contact specified by the ID in the URI.

Response Body

The response body will contain a list of each field on the contact object, along with
metadata such as date last modified and relation links. Modified date format is
compliant to ISO-8601.

XML Example:

<?xml version="1.0" encoding="UTF-8"?>

<contact id="5" modifiedDate="2012-08-15T15:52:01-0400">

<link rel="self" href="/{API_URL}/core/contactlists/{listId}/contacts/5" />

<link rel="next" href="/{API_URL}/core/contactlists/{listId}/contacts/6" />

<link rel="prev" href="/{API_URL}/core/contactlists/{listId}/contacts/4" />

<field id="email">This email address is being protected from spambots. You need JavaScript enabled to view it.<';document.getElementById('cloak43f19cd608057d1812eb7dfc3076e797').innerHTML += ''+addy_text43f19cd608057d1812eb7dfc3076e797+'<\/a>'; ;/field>

<field id="mobile">1-555-555-1234</field>

<field id="name">Jane Smith</field>

</contact>

JSON Example:

{

"contact": {

   "id": "5",

   "modifiedDate": "2012-08-15T15:52:01-0400",

   "@links": [

     {"rel": "self", "href": "{API_URL}/core/contactlists/{listId}/contacts/5"},

     {"rel": "next", "href": "{API_URL}/core/contactlists/{listId}/contacts/6"},

     {"rel": "prev", "href": "{API_URL}/core/contactlists/{listId}/contacts/4"}

   ],

   "fields": {

     "email": {"value": "This email address is being protected from spambots. You need JavaScript enabled to view it."},

     "mobile": {"value": "1-555-555-1234"},

     "name": {"value": "Jane Smith"}

   }

}

}

 

 

Modify Contact

POST core/contactlists/{id}/contacts/{id}

Description

This method will update the field data of the contact specified by the ID in the URI.
If the ID does not exist in the list, this method will not create a resource for it.

Request Body

Specify the fields you would like to update. You only need to include fields that are
to be updated; omitted fields wil be left alone. Field IDs are a one-to-one mapping with
column IDs in the list.

XML Example:

<?xml version="1.0" encoding="UTF-8"?>

<contact>

<field id="email">This email address is being protected from spambots. You need JavaScript enabled to view it.<';document.getElementById('cloak70c3138712c94844d3b1ec591eef0605').innerHTML += ''+addy_text70c3138712c94844d3b1ec591eef0605+'<\/a>'; ;/field>

</contact>

JSON Example:

  

{

"contact": {

   "fields": {

     "email": "This email address is being protected from spambots. You need JavaScript enabled to view it."

   }

}

}

Response Body

The response body will include the entire updated contact representation, including relation links. Modified date format is compliant to ISO-8601.

XML Example:

<?xml version="1.0" encoding="UTF-8"?>

<contact id="5" modifiedDate="2012-08-15T15:52:01-0400">

<link rel="self" href="/{API_URL}/core/contactlists/{listId}/contacts/5" />

<link rel="next" href="/{API_URL}/core/contactlists/{listId}/contacts/6" />

<link rel="prev" href="/{API_URL}/core/contactlists/{listId}/contacts/4" />

<field id="email">This email address is being protected from spambots. You need JavaScript enabled to view it.<';document.getElementById('cloak8894d06b673dd9b81c1bd811df4177d5').innerHTML += ''+addy_text8894d06b673dd9b81c1bd811df4177d5+'<\/a>'; ;/field>

<field id="mobile">1-555-555-1234</field>

<field id="name">Jane Smith</field>

</contact>

JSON Example:

{

"contact": {

   "id": "5",

   "modifiedDate": "2012-08-15T15:52:01-0400",

   "@links": [

     {"rel": "self", "href": "{API_URL}/core/contactlists/{listId}/contacts/5"},

     {"rel": "next", "href": "{API_URL}/core/contactlists/{listId}/contacts/6"},

     {"rel": "prev", "href": "{API_URL}/core/contactlists/{listId}/contacts/4"}

   ],

   "fields": {

     "email": {"value": "This email address is being protected from spambots. You need JavaScript enabled to view it."},

     "mobile": {"value": "1-555-555-1234"},

     "name": {"value": "Jane Smith"}

   }

}

}

 

Delete Contact

DELETE core/contactlists/{id}/contacts/{id}

Description

This method will delete the contact specified by the ID in the URI.

 

 

Batch Upload Contacts

POST core/contactlists/{id}/contacts/batch

Description

This method allows the upload of up to 100 contacts in a single request.

Request Body

The request body should contain a collection of contacts to upload. See the examples below for correct formatting.

XML Example:

<contacts>

<contact>

   <field id="email">This email address is being protected from spambots. You need JavaScript enabled to view it.<';document.getElementById('cloakd581142f40fffa296467dee09ec7c82e').innerHTML += ''+addy_textd581142f40fffa296467dee09ec7c82e+'<\/a>'; ;/field>

   <field id="mobile">1-555-555-1234</field>

   <field id="name">John Smith</field>

</contact>

<contact>

   <field id="email">This email address is being protected from spambots. You need JavaScript enabled to view it.<';document.getElementById('cloakad48fc30a1122bccb2818e6630c81333').innerHTML += ''+addy_textad48fc30a1122bccb2818e6630c81333+'<\/a>'; ;/field>

   <field id="mobile">1-555-555-1234</field>

   <field id="name">John Smith</field>

</contact>

<contact>

   <field id="email">This email address is being protected from spambots. You need JavaScript enabled to view it.<';document.getElementById('cloak9d1e02535193c61b675364a26ec16c21').innerHTML += ''+addy_text9d1e02535193c61b675364a26ec16c21+'<\/a>'; ;/field>

   <field id="mobile">1-555-555-1234</field>

   <field id="name">John Smith</field>

</contact>

</contacts>

JSON Example:

{

"contacts": [

   {

     "fields": {

       "email":"This email address is being protected from spambots. You need JavaScript enabled to view it.",

       "mobile":"1-555-555-1234",

       "name":"John Smith"

     }

   }, {

     "fields": {

       "email":"This email address is being protected from spambots. You need JavaScript enabled to view it.",

       "mobile":"1-555-555-1234",

       "name":"John Smith"

     }

   }, {

     "fields": {

       "email":"This email address is being protected from spambots. You need JavaScript enabled to view it.",

       "mobile":"1-555-555-1234",

      "name":"John Smith"

     }

   }

]

}

Response Body

The response body will contain information about the batch process, including response data

XML Example:

<?xml version="1.0" encoding="UTF-8"?>

<batchInfo id="d33">

   <link rel="self" href="/{API_URL}/api/core/contactlists/1001001/batch/d33"/>

</batchInfo>

JSON Example:

{

"batchInfo": {

   "id":"d33",

   "@link": {

     "rel":"self",

     "href":"{API_URL}\/api\/core\/contactlists\/5870613\/batch\/d33"

   }

}

}

 

Get Batch Contact Upload Status

GET core/contactlists/{id}/contacts/batch/{id}

Description

Retrieve the status of a batch upload. The ID for the upload is returned when the request is first placed.

Response Body

The return will either be a status indicating that the request is still processing, or a series of links to the created contact resources.

XML Example:

<?xml version="1.0" encoding="UTF-8"?>

<links>

<link rel="self" href="http://api.buzzportal.com/core/contactlists/5870613/contacts/598"/>

<link rel="self" href="http://api.buzzportal.com/core/contactlists/5870613/contacts/599"/>

<link rel="self" href="http://api.buzzportal.com/core/contactlists/5870613/contacts/600"/>

</links>

JSON Example:

{

"@links": [{

   "rel":"self",

   "href":"http:\/\/api.buzzportal.com\/core\/contactlists\/5870613\/contacts\/598"

}, {

   "rel":"self",

   "href":"http:\/\/api.buzzportal.com\/core\/contactlists\/5870613\/contacts\/599"

}, {

   "rel":"self",

   "href":"http:\/\/api.buzzportal.com\/core\/contactlists\/5870613\/contacts\/600"

}]

}