This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
api-contacts [2017/07/04 12:37] ben [Endpoint] |
api-contacts [2018/05/23 11:29] (current) benc |
||
---|---|---|---|
Line 63: | Line 63: | ||
==== Request Body ==== | ==== Request Body ==== | ||
- | Request body is only required if including [[/contact-fields|Contact Fields]]. The example below would add a new [[/contacts|Contact]] with the FirstName and LastName [[/contact-fields|Contact Fields]] being set. | + | Request body is only needed if including [[/contact-fields|Contact Fields]]. The example below would add a new [[/contacts|Contact]] with the FirstName and LastName [[/contact-fields|Contact Fields]] being set. |
|Example|<code javascript>{ | |Example|<code javascript>{ | ||
Line 147: | Line 147: | ||
In the described situation of the original Request's URI //and// body containing an Email Address and a Contact eixsting for both of them, the Contact with the body's Email Address is returned. | In the described situation of the original Request's URI //and// body containing an Email Address and a Contact eixsting for both of them, the Contact with the body's Email Address is returned. | ||
+ | |||
+ | |||
+ | ===== Delete a Contact ===== | ||
+ | |||
+ | This endpoint is used to delete an existing [[/contacts|Contact]] from the Sentori Account. | ||
+ | |||
+ | ==== Endpoint ==== | ||
+ | |||
+ | |URI| <nowiki>https://api.sentoriapp.com/v2.0/contact/delete/joe%40example.sentoriapp.com/</nowiki>| | ||
+ | |Method| POST| | ||
+ | |||
+ | ==== Request Body ==== | ||
+ | |||
+ | Leave blank. | ||
+ | |||
+ | |||
+ | |||
+ | |||
===== Get Contact Structure ===== | ===== Get Contact Structure ===== | ||
Line 215: | Line 233: | ||
|URI| <nowiki>https://api.sentoriapp.com/v2.0/contact/subscribe/joe%40example.sentoriapp.com/MailingListExternalID/</nowiki>| | |URI| <nowiki>https://api.sentoriapp.com/v2.0/contact/subscribe/joe%40example.sentoriapp.com/MailingListExternalID/</nowiki>| | ||
- | |Method| GET | | + | |Method| POST | |
===== Unsubscribe Contact from Mailing List ===== | ===== Unsubscribe Contact from Mailing List ===== | ||
Line 225: | Line 243: | ||
|URI| <nowiki>https://api.sentoriapp.com/v2.0/contact/unsubscribe/joe%40example.sentoriapp.com/MailingListExternalID/</nowiki>| | |URI| <nowiki>https://api.sentoriapp.com/v2.0/contact/unsubscribe/joe%40example.sentoriapp.com/MailingListExternalID/</nowiki>| | ||
- | |Method| GET | | + | |Method| POST | |
===== Unsubscribe Contact ===== | ===== Unsubscribe Contact ===== | ||
Line 235: | Line 253: | ||
|URI| <nowiki>https://api.sentoriapp.com/v2.0/contact/unsubscribe/joe%40example.sentoriapp.com/</nowiki>| | |URI| <nowiki>https://api.sentoriapp.com/v2.0/contact/unsubscribe/joe%40example.sentoriapp.com/</nowiki>| | ||
- | |Method| GET | | + | |Method| POST | |
===== Import Contacts ===== | ===== Import Contacts ===== | ||
Line 300: | Line 318: | ||
|URI| <nowiki>https://api.sentoriapp.com/v2.0/contact/import/{{UploadGroupExternalID}}/attach/{{DocumentExternalID}}</nowiki>| | |URI| <nowiki>https://api.sentoriapp.com/v2.0/contact/import/{{UploadGroupExternalID}}/attach/{{DocumentExternalID}}</nowiki>| | ||
- | |Method| GET | | + | |Method| POST | |