Zendesk Developers :: REST API Documentation

Forum Subscriptions

JSON Format

Forum subscriptions are links between users and forums they subscribe to

Name	Type	Read-only	Mandatory	Comment
id	integer	yes	no	Automatically assigned upon creation
forum_id	integer	no	yes	The forum being subscribed to
user_id	integer	no	yes	The user subscribed to the forum
created_at	date	yes	no	The time the subscription was created

Example

{
  "id":              35436,
  "forum_id":        32,
  "user_id":         482,
  "created_at":      "2009-07-20T22:55:29Z"
}

List Forum Subscriptions

GET /api/v2/forum/{forum_id}/subscriptions.json

GET /api/v2/forum_subscriptions.json

Allowed For:

Agents

Using curl

curl https://{subdomain}.zendesk.com/api/v2/forum_subscriptions.json \
  -v -u {email_address}:{password}

Example Response

Status: 200 OK

{
  "forum_subscriptions": [
    {
      "id":              35436,
      "forum_id":        32,
      "user_id":         482,
      "created_at":      "2009-07-20T22:55:29Z"
    },
    {
      "id":              43681,
      "forum_id":        334,
      "user_id":         9471,
      "created_at":      "2011-08-22T21:12:09Z"
    }
  ]
}

Show Forum Subscription

GET /api/v2/forum_subscriptions/{id}.json

Allowed For:

Agents

Using curl

curl https://{subdomain}.zendesk.com/api/v2/forum_subscriptions/{id}.json \
  -v -u {email_address}:{password}

Example Response

Status: 200 OK

{
  "forum_subscription": {
    "id":              35436,
    "forum_id":        32,
    "user_id":         482,
    "created_at":      "2009-07-20T22:55:29Z"
  }
}

Create Forum Subscription

POST /api/v2/forum_subscriptions.json

Allowed For:

Agents

Using curl

curl https://{subdomain}.zendesk.com/api/v2/forum_subscriptions.json \
  -d '{"forum_subscription": {"user_id": 772, "forum_id": 881}}' \
  -v -u {email_address}:{password} -H "Content-Type: application/json" -X POST

Example Response

Status: 201 Created

{
  "forum_subscription": {
    "id":              55436,
    "forum_id":        881,
    "user_id":         772,
    "created_at":      "2012-04-20T22:55:29Z"
  }
}

Delete Forum Subscription

DELETE /api/v2/forum_subscriptions/{id}.json

Allowed For

Agents

Using curl

curl https://{subdomain}.zendesk.com/api/v2/forum_subscriptions/{id}.json \
  -v -u {email_address}:{password} -X DELETE

Example Response

Status: 200 OK