Overview 

This article provides details about the REST - NewsSubscriber API call that Kayako Classic uses, including its field types, arguments, and responses.

• GET /News/Subscriber
  • Response
• GET /News/Subscriber/$id$
  • Arguments
  • Response
• POST /News/Subscriber
  • Arguments (POST variables)
  • Response
• PUT /News/Subscriber/$id$
  • Arguments
  • Response
• DELETE /News/Subscriber/$id$
  • Arguments

 

Information

GET /News/Subscriber

Retrieve all subscribers.

Response

<newssubscribers>
 <newssubscriber>
  <id>1</id>
  <tgroupid>1</tgroupid>
  <userid>0</userid> 
  <email><![CDATA[john.doe@kayako.com]]]]><![CDATA[></email>
  <isvalidated>0</isvalidated>
  <usergroupid>1</usergroupid>
  </newssubscriber>
  <newssubscriber>
   <id>2</id>
   <tgroupid>1</tgroupid>
   <userid>0</userid>
   <email><![CDATA[rohan.sharma@kayako.com]]]]><![CDATA[></email>
   <isvalidated>1</isvalidated>
   <usergroupid>1</usergroupid>
  </newssubscriber>
   <newssubscriber>
    <id>3</id>
    <tgroupid>1</tgroupid>
    <userid>0</userid>
    <email><![CDATA[email@domain.com]]]]><![CDATA[></email>
    <isvalidated>0</isvalidated>
    <usergroupid>1</usergroupid>
  </newssubscriber>
</newssubscribers>

 

GET /News/Subscriber/$id$

Retrieve the subscriber identified by $id$.

Arguments

Red = required

Name	Description
$id$	The unique numeric identifier of the subscriber

Response

<newssubscribers>
<newssubscriber>
<id>1</id>
<tgroupid>1</tgroupid>
<userid>0</userid>
<email><![CDATA[john.doe@kayako.com]]]]><![CDATA[></email>
<isvalidated>0</isvalidated>
<usergroupid>1</usergroupid>
</newssubscriber>
</newssubscribers>

 

POST /News/Subscriber

A new news subscriber.

Arguments (POST variables)

Red = required

Name	Description
email	The email address
isvalidated	Email is validated. 0 (default) or 1

Response

<newssubscribers>
 <newssubscriber>
  <id>1</id>
  <tgroupid>1</tgroupid>
  <userid>0</userid>
  <email><![CDATA[john.doe@kayako.com]]]]><![CDATA[></email>
  <isvalidated>0</isvalidated>
  <usergroupid>1</usergroupid>
 </newssubscriber>
</newssubscribers>

 

PUT /News/Subscriber/$id$

Update news subscriber identified by $id$.

Arguments

Red = required

Name	Description
email	The email address

Response

<newssubscribers>
 <newssubscriber>
  <id>1</id>
  <tgroupid>1</tgroupid>
  <userid>0</userid>
  <email><![CDATA[john.doe@kayako.com]]]]><![CDATA[></email>
  <isvalidated>0</isvalidated>
  <usergroupid>1</usergroupid>
 </newssubscriber>
</newssubscribers>

 

DELETE /News/Subscriber/$id$

Delete a news subscriber identified by $id$.

Arguments

Red = required

Name	Description
$id$	The unique numeric identifier of the subscriber