App Locations
For more information on locations, see Setting the app location in the Apps developer docs.
JSON format
App Locations are represented as JSON objects with the following properties:
| Name | Type | Read-only | Mandatory | Description |
|---|---|---|---|---|
| collapsible | boolean | true | false | The value is true if reordering has any effect |
| host_application | string | true | false | The unique host application key |
| id | integer | true | false | Internal location ID |
| name | string | true | false | The unique location key |
| orderable | boolean | true | false | The value is true if reordering has any effect |
| product_code | integer | true | false | Internal product ID |
| visible | boolean | true | false | The value is true if users can see and access location |
Example
{"collapsible": true,"host_application": "zendesk","id": 1,"name": "top_bar","orderable": true,"product_code": 1,"visible": true}
List Locations
GET /api/sell/apps/locations
Returns a list of available locations in Zendesk Sell for apps.
Allowed for
- Admins
Using curl
curl https://{subdomain}.zendesk.com/api/sell/apps/locations.json \-u {email_address}:{password}
Example Response
Status 200 OK{"locations": [{"id": 15,"name": "deal_card","product_code": 4,"host_application": "sell","orderable": false,"collapsible": true,"visible": true},{"id": 16,"name": "person_card","product_code": 4,"host_application": "sell","orderable": false,"collapsible": true,"visible": true},{"id": 17,"name": "company_card","product_code": 4,"host_application": "sell","orderable": false,"collapsible": true,"visible": true},{"id": 18,"name": "lead_card","product_code": 4,"host_application": "sell","orderable": false,"collapsible": true,"visible": true},{"id": 19,"name": "background","product_code": 4,"host_application": "sell","orderable": false,"collapsible": false,"visible": false},{"id": 20,"name": "modal","product_code": 4,"host_application": "sell","orderable": false,"collapsible": false,"visible": false},{"id": 21,"name": "dashboard","product_code": 4,"host_application": "sell","orderable": false,"collapsible": false,"visible": true},{"id": 22,"name": "note_editor","product_code": 4,"host_application": "sell","orderable": false,"collapsible": false,"visible": true},{"id": 23,"name": "call_log_editor","product_code": 4,"host_application": "sell","orderable": false,"collapsible": false,"visible": true},{"id": 24,"name": "email_editor","product_code": 4,"host_application": "sell","orderable": false,"collapsible": false,"visible": true},{"id": 25,"name": "top_bar","product_code": 4,"host_application": "sell","orderable": false,"collapsible": false,"visible": true},{"id": 26,"name": "visit_editor","product_code": 4,"host_application": "sell","orderable": false,"collapsible": false,"visible": true}]}
App Location Installations
JSON format
App Installation Locations are represented as JSON objects with the following properties:
| Name | Type | Read-only | Mandatory | Description |
|---|---|---|---|---|
| created_at | string | true | false | When this record was created |
| id | integer | true | false | Internal location installation id |
| installations | array | false | false | An array of app installation ids |
| location_name | string | false | false | Location name. Example: nav_bar |
| updated_at | string | true | false | When this record was last updated |
Example
{"created_at": "2014-03-31T03:10:52Z","id": 1234,"installations": [8765, 5678],"location_name": "top_bar","updated_at": "2014-07-29T06:22:02Z"}
List Location Installations
GET /api/sell/apps/location_installations
Allowed for
- Admins
Using curl
curl https://{subdomain}.zendesk.com/api/sell/apps/location_installations.json \-u {email_address}:{password}
Example Response
Status 200 OK{"location_installations": [{"location_name": "deal_card","installations": [82,56]},{"location_name": "person_card","installations": [82,111,56]},{"location_name": "company_card","installations": [82,56]},{"location_name": "lead_card","installations": [82,56]},{"location_name": "background","installations": [82,87,56,96]},{"location_name": "note_editor","installations": [82]},{"location_name": "call_log_editor","installations": [82]},{"location_name": "email_editor","installations": [82]},{"location_name": "top_bar","installations": [82,87,56,96]}]}