Resource Definitions:Lists/ID/Contacts/ID
From API Documentation
(Difference between revisions)
Line 81: | Line 81: | ||
</div> | </div> | ||
[[Category:Resource Definitions]] | [[Category:Resource Definitions]] | ||
+ | [[Category:Agent Resources]] |
Latest revision as of 15:14, 23 July 2010
The lists/ID/contacts/ID resource is an individual contact-to-list association between the designated distribution list and contact, where the first "ID" is the list's list_id number and the second "ID" is the contact's contact_id number.
Example URI: http://api.rezora.com/v1/lists/1234/contacts/123456
Available methods are:
Contents |
GET
Returns an individual contact-to-list association between the designated distribution list and contact. The association record includes the following fields:
- contacttolist_id
- contact_id
- list_id
- contacttolist_date
Example Responses
XML Response
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?> <list_contacts version="1.0"> <list_contact> <contacttolist_id>1234567</contacttolist_id> <contact_id>123456</contact_id> <list_id>1234</list_id> <contacttolist_date>2010-07-21 16:46:01</contacttolist_date> </list_contact> </list_contacts>
JSON Response
[ { "contacttolist_id":"1234567", "contact_id":"123456", "list_id":"1234", "contacttolist_date":"2010-07-21 16:46:01" } ]
CSV Response
"contacttolist_id"|"contact_id"|"list_id"|"contacttolist_date" "1234567"|"123456"|"1234"|"2010-07-21 16:46:01"
DELETE
Permanently removes an individual contact-to-list association between the designated distribution list and contact, and returns a success code.
Example Response Data
XML Response
<?xml version="1.0" encoding="UTF-8"?> <list_contacts version="1.0"> <list_contact> <status>200</status> </list_contact> </list_contacts>
JSON Response
[ { "status":"200" } ]
CSV Response
"status" "200"