Topics are used to group contacts and objects (which may contain one or more contacts) to make sending notifications/alerts to groups of people about a specific topic more convenient.
HTTP PUT
PUT /api/2013-12-01/Topics/[Agency ID]/[Topic Name]/subscribe
You must PUT at a minimum either an array of Contacts or an array of Objects.
Parameter | Description |
---|---|
Contacts | An array of Contact ID numbers for the contacts you’d like to subscribe. |
Objects | An array of Object ID numbers for the objects you’d like to subscribe. |
Example Request
$ curl -XPUT https://[Site Name].readyop.com/api/2013-12-01/Topics/[Agency ID]/[Topic Name]/subscribe -d "Contacts[]=1234" -d "Contacts[]=4321" -d "Objects[]=5678" \
-u "[API Account ID]:[API Token]"
Request Result
{
"code": 0,
"status": 200,
"detail": "Success",
"timestamp": "2015-09-21T15:39:22+00:00"
}