Organization Subscriptions

Agents in an organization can subscribe to be notified whenever someone in their organization submits a ticket. The agents will be notified as long as they're allowed to see all tickets or the organization's tickets. See Setting agent privileges and defining ticket access in the Zendesk Support knowledge base.

End users can also subscribe to be notified if they're members of a shared organization. See Setting up a shared organization for end-users and Viewing and editing a user's profile in the knowledge base.

List Organization Subscriptions

GET /api/v2/organizations/{organization_id}/subscriptions.json

GET /api/v2/organization_subscriptions.json

GET /api/v2/users/{user_id}/organization_subscriptions.json

Allowed For:
  • Agents
  • End users

For end users, the response will only list the subscriptions created by the requesting end user.

Using curl
curl https://{subdomain}.zendesk.com/api/v2/organization_subscriptions.json \
  -v -u {email_address}:{password}
Example Response
Status: 200 OK

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

Show Organization Subscription

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

Allowed For:
  • Agents
  • End users

For end users, the response will show only the subscription if it was created by the requesting end user.

Using curl
curl https://{subdomain}.zendesk.com/api/v2/organization_subscriptions/{id}.json \
  -v -u {email_address}:{password}
Example Response
Status: 200 OK

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

Create Organization Subscription

POST /api/v2/organization_subscriptions.json

Allowed For:
  • Agents
  • End users

End users can only subscribe to shared organizations in which they're members.

Using curl
curl https://{subdomain}.zendesk.com/api/v2/organization_subscriptions.json \
  -d '{"organization_subscription": {"user_id": 772, "organization_id": 881}}' \
  -v -u {email_address}:{password} -H "Content-Type: application/json" -X POST
Example Response
Status: 200 OK

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

Delete Organization Subscription

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

Allowed For
  • Agents
  • End users
Using curl
curl https://{subdomain}.zendesk.com/api/v2/organization_subscriptions/{id}.json \
  -v -u {email_address}:{password} -X DELETE
Example Response
Status: 204 No Content