App Location Installations

You can control the order of apps in specific locations.

For more information on locations, see Setting the app location in the Apps developer docs.

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": "nav_bar",
  "updated_at": "2014-07-29T06:22:02Z"
}

List Location Installations

• GET /api/v2/apps/location_installations

Allowed for

• Admins

Using curl

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

Example Response

Status 200 OK

{
  "location_installations": [
    {
      "installations": [
        82,
        56
      ],
      "location_name": "nav_bar"
    },
    {
      "installations": [
        111,
        82,
        87,
        56,
        46,
        96,
        77
      ],
      "location_name": "ticket_sidebar"
    },
    {
      "installations": [
        111,
        82,
        56
      ],
      "location_name": "new_ticket_sidebar"
    },
    {
      "installations": [
        106,
        91
      ],
      "location_name": "top_bar"
    }
  ]
}

Reorder App Installations For Location

• POST /api/v2/apps/location_installations/reorder

Creates or updates the relevant location installation with a specified installation order.

When implementing this API in response to a user reordering installations, ensure you throttle your API calls to a reasonable limit.

Allowed For

• Admins

Using curl

curl https://{subdomain}.zendesk.com/api/v2/apps/location_installations/reorder.json \
  -d '{"installations": [82, 56], "location_name": "nav_bar"}' \
  -H "Content-Type: application/json" -X POST \
  -u {email_address}:{password}

Example Response

Status 201 Created

{
  "location_installation": {
    "installations": [
      82,
      56
    ],
    "location_name": "nav_bar"
  }
}