Accounts

You can use the API to get or set account information.

If you created your Zendesk Chat account in Zendesk Support, access to the Chat Accounts and Agents APIs is restricted to GET requests. You can still use the other Chat APIs normally.

JSON Format

Accounts are represented as JSON objects with the following attributes.

Name Type Read-only Description
account_key string yes The widget key for the account
create_date timestamp yes The date of creation of the account
status string yes The status of the account
plan dictionary yes Information about the package of the account
billing email no The billing information of the account

Get Account

GET /api/v2/account

Gets all the information about your account.

Allowed for
  • Owner
Using cURL
curl https://www.zopim.com/api/v2/account \
  -v -u {email_address}:{password}
Example Response
HTTP/1.1 200 OK
Content-Type: application/json

{
  "account_key" : "zendesk-chat-account-key",
  "create_date" : "2014-08-06T11:02:09Z",
  "status" : "active",
  "plan" : {
    "file_upload": true,
    "operating_hours": false,
    "long_desc": "Ideal for most Lean Teams to Engage Customers.",
    "max_concurrent_chats": "unlimited",
    "integrations": true,
    "analytics": false,
    "weekly_reports": false,
    "max_advanced_triggers": 2,
    "max_agents": 2,
    "max_history_search_days": "unlimited",
    "name": "team",
    "widget_customization": "full",
    "short_desc": "Great for Lean Teams",
    "max_departments": 2,
    "max_basic_triggers": 2
  },
  "billing" :  {
    "first_name" : "Jonathan",
    "last_name" : "Doe",
    "email" : "john@doe.com",
    "additional_info" : "",
    "cycle" : 1,
    "phone" : "+12(1)123456",
    "company" : "John and Friends",
    "address1" : "123 Fictional Street",
    "address2" : "",
    "city" : "West Fiction",
    "postal_code" : "12345",
    "state" : "Oklahoma",
    "country_code" : "US",
  }
}

Update Account

PUT /api/v2/account

Updates the details of your account.

Allowed for
  • Owner
Using cURL
curl https://www.zopim.com/api/v2/account \
  -d '{"billing": {"email": "johndoe@zendesk.com", "first_name": "John"}}' \
  -v -u {email_address}:{password} \
  -X PUT -H "Content-Type: application/json"
Example Response
HTTP/1.1 200 OK
Content-Type: application/json

{
  "account_key" : "zendesk-chat-account-key",
  "billing" : {
    "first_name": "John",
    "email" : "johndoe@zendesk.com",
    ...
  }
  ...
}