Documentation API Reference

App Location Installations

你这n control the order of apps in specific locations.

For more information on locations, seeSetting the app locationin 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

代码示例

旋度 
              

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

               
import("fmt""io""net/http")funcmain(){url:="https://support.zendesk.com/api/v2/apps/location_installations"method:="GET"req,err:=http.NewRequest(method,url,nil)iferr!=nil{fmt.Println(err)return}req.Header.Add("Content-Type","application/json")req.Header.Add("Authorization","Basic ")// Base64 encoded "username:password"client:=&http.Client{}res,err:=client.Do(req)iferr!=nil{fmt.Println(err)return}deferres.Body.Close()body,err:=io.ReadAll(res.Body)iferr!=nil{fmt.Println(err)return}fmt.Println(string(body))}
Java 
              

               
importcom.squareup.okhttp.*;OkHttpClientclient=newOkHttpClient();HttpUrl.BuilderurlBuilder=HttpUrl.parse("https://support.zendesk.com/api/v2/apps/location_installations").newBuilder();Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("GET",null).addHeader("Content-Type","application/json").addHeader("Authorization",Credentials.basic("your-email","your-password")).build();Responseresponse=client.newCall(request).execute();
Nodejs 
              

               
varaxios=require('axios');varconfig={method:'GET',url:'https://support.zendesk.com/api/v2/apps/location_installations',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});
Python 
              

               
importrequestsurl="https://support.zendesk.com/api/v2/apps/location_installations"headers={"Content-Type":"application/json",}response=requests.request("GET",url,auth=('',''),headers=headers)print(response.text)
Ruby 
              

               
require"net/http"uri=URI("https://support.zendesk.com/api/v2/apps/location_installations")request=Net::HTTP::Get.new(uri,"Content-Type":"application/json")request.basic_auth"username","password"response=Net::HTTP.start uri.hostname,uri.port,use_ssl:truedo|http|http.request(request)end

Example response(s)

200 OK 
              

               
// 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

代码示例

旋度 
              

               
旋度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}
Go 
              

               
import("fmt""io""net/http")funcmain(){url:="https://support.zendesk.com/api/v2/apps/location_installations/reorder"method:="POST"req,err:=http.NewRequest(method,url,nil)iferr!=nil{fmt.Println(err)return}req.Header.Add("Content-Type","application/json")req.Header.Add("Authorization","Basic ")// Base64 encoded "username:password"client:=&http.Client{}res,err:=client.Do(req)iferr!=nil{fmt.Println(err)return}deferres.Body.Close()body,err:=io.ReadAll(res.Body)iferr!=nil{fmt.Println(err)return}fmt.Println(string(body))}
Java 
              

               
importcom.squareup.okhttp.*;OkHttpClientclient=newOkHttpClient();HttpUrl.BuilderurlBuilder=HttpUrl.parse("https://support.zendesk.com/api/v2/apps/location_installations/reorder").newBuilder();RequestBodybody=RequestBody.create(MediaType.parse("application/json"),"""""");Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("POST",body).addHeader("Content-Type","application/json").addHeader("Authorization",Credentials.basic("your-email","your-password")).build();Responseresponse=client.newCall(request).execute();
Nodejs 
              

               
varaxios=require('axios');varconfig={method:'POST',url:'https://support.zendesk.com/api/v2/apps/location_installations/reorder',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});
Python 
              

               
importrequestsurl="https://support.zendesk.com/api/v2/apps/location_installations/reorder"headers={"Content-Type":"application/json",}response=requests.request("POST",url,auth=('',''),headers=headers)print(response.text)
Ruby 
              

               
require"net/http"uri=URI("https://support.zendesk.com/api/v2/apps/location_installations/reorder")request=Net::HTTP::Post.new(uri,"Content-Type":"application/json")request.basic_auth"username","password"response=Net::HTTP.start uri.hostname,uri.port,use_ssl:truedo|http|http.request(request)end

Example response(s)

201 Created 
              

               
// Status 201 Created{"location_installation":{"installations":[82,56],"location_name":"nav_bar"}}