Use this API to ingest external content records for search. The help center search engine indexes and ranks the content. When an end user clicks an external content search result, they're taken to the URL of the external content record.

For more information, seeIntroductionandSetting up Zendesk Federated Search in your help centerin Zendesk help.

JSON format

Records are represented as JSON objects with the following properties:

Name Type Read-only Mandatory Description
body string false true The body of the record. We will truncate the size of the body to our maxLength if it exceeds the limit.
created_at string false false iso - 8601 da兼容te-time reflecting the time the event was created. If not set, the API sets the value when it receives the event
external_id string false true A string that uniquely identifies the record in your system
id string true false Universally Unique Lexicographically Sortable Identifier. Seehttps://github.com/ulid/spec
locale string false true Record locale. Must match a locale already enabled in your help center in order to be returned in search. SeeZendesk language support by productin Zendesk help
source_id string false true Universally Unique Lexicographically Sortable Identifier. Seehttps://github.com/ulid/spec
title string false true The title of the record
type_id string false true Universally Unique Lexicographically Sortable Identifier. Seehttps://github.com/ulid/spec
updated_at string false false iso - 8601 da兼容te-time reflecting the time the event was last updated
url string false true An accessible URL for the record in your system
user_segment_id string false false The Guide user segment which this record should be visible to. If not set, the record will be visible to all users

List External Content Records

  • GET /api/v2/guide/external_content/records

Lists external content records.

Allowed For

  • Help Center managers

Parameters

Name Type In Required Description
page object 查询 false Paginate query

Code Samples

curl
              
curlhttps://{subdomain}.zendesk.com/api/v2/guide/external_content/records\-v -u{email_address}:{password}
Go
              
import("fmt""io""net/http")funcmain(){url:="https://support.zendesk.com/api/v2/guide/external_content/records?page="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/guide/external_content/records").newBuilder().addQueryParameter("page","");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/guide/external_content/records',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},params:{'page':'',},};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/guide/external_content/records?page="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/guide/external_content/records")uri.query=URI.encode_www_form("page":"")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{"meta":{"after_cursor":"MW","before_cursor":"MQ","has_more":true},"records":[{"body":"We want to hear what you have to say about external content search, because ultimately we're building it for you. Below, you can find some guidelines on the best ways to let us know what you think. Right here -- this forum is the best place. With this format, we can respond to questions or comments so that everyone can see and benefit. We also encourage you to make it as social and collaborative as possible, so jump in if you have an idea that might help someone else.","created_at":"2020-07-08T12:27:26Z","external_id":"360046759835","id":"01EC05A5T1J4ZSDJX4Q8JGFRHP","locale":"en-us","source":{"id":"01E77R4513SKX3AE8H20Q0KJ1K","name":"My Library"},"title":"How to leave feedback for Federated Help Center search","type":{"id":"01EBDWWC98ZF7DK9YQF3DK9Y77","name":"Blog"},"updated_at":"2020-07-08T12:27:26Z","url":"https://support.zendesk.com/hc/en-us/community/posts/360046759834-How-to-leave-feedback-for-Federated-Help-Center-search","user_segment_id":"-1"}]}

Show External Content Record

  • GET /api/v2/guide/external_content/records/{id}

Gets the specified external content record.

Allowed For

  • Help Center managers

Parameters

Name Type In Required Description
id string Path true ULID for the object

Code Samples

curl
              
curlhttps://{subdomain}.zendesk.com/api/v2/guide/external_content/records/{id}\-v -u{email_address}:{password}
Go
              
import("fmt""io""net/http")funcmain(){url:="https://support.zendesk.com/api/v2/guide/external_content/records/01E7GZVZHBWYD50V00XDMYCMYP"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/guide/external_content/records/01E7GZVZHBWYD50V00XDMYCMYP").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/guide/external_content/records/01E7GZVZHBWYD50V00XDMYCMYP',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/guide/external_content/records/01E7GZVZHBWYD50V00XDMYCMYP"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/guide/external_content/records/01E7GZVZHBWYD50V00XDMYCMYP")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{"record":{"body":"We want to hear what you have to say about external content search, because ultimately we're building it for you. Below, you can find some guidelines on the best ways to let us know what you think. Right here -- this forum is the best place. With this format, we can respond to questions or comments so that everyone can see and benefit. We also encourage you to make it as social and collaborative as possible, so jump in if you have an idea that might help someone else.","created_at":"2020-07-08T12:27:26Z","external_id":"360046759835","id":"01EC05A5T1J4ZSDJX4Q8JGFRHP","locale":"en-us","source":{"id":"01E77R4513SKX3AE8H20Q0KJ1K","name":"My Library"},"title":"How to leave feedback for Federated Help Center search","type":{"id":"01EBDWWC98ZF7DK9YQF3DK9Y77","name":"Blog"},"updated_at":"2020-07-08T12:27:26Z","url":"https://support.zendesk.com/hc/en-us/community/posts/360046759834-How-to-leave-feedback-for-Federated-Help-Center-search","user_segment_id":"-1"}}

Create External Content Record

  • POST /api/v2/guide/external_content/records

Creates an external content record. Specify atype_idandsource_idfor this request. You can retrieve the ids usingList External Content TypesandList External Content Sources.

Allowed For

  • Help Center managers

Example body

             
{"record":{"body":"We want to hear what you have to say about external content search, because ultimately we're building it for you. Below, you can find some guidelines on the best ways to let us know what you think. Right here -- this forum is the best place. With this format, we can respond to questions or comments so that everyone can see and benefit. We also encourage you to make it as social and collaborative as possible, so jump in if you have an idea that might help someone else.","external_id":"360046759835","locale":"en-us","source_id":"01E77R4513SKX3AE8H20Q0KJ1K","title":"How to leave feedback for Federated Help Center search","type_id":"01EBDWWC98ZF7DK9YQF3DK9Y77","url":"https://support.zendesk.com/hc/en-us/community/posts/360046759834-How-to-leave-feedback-for-Federated-Help-Center-search","user_segment_id":"-1"}}

Code Samples

curl
              
curlhttps://{subdomain}.zendesk.com/api/v2/guide/external_content/records\-d'{ "record": { "title": "Mansfield Park", "url": "http://www.publicbookshelf.com/regency/mansfield-park/mansfieldpark8", "locale": "en-uk", "body": "Before his return Mrs. Grant and Miss Crawford came in.", "external_id": "mansfieldpark8", "user_segment_id": null, "type_id": "01E77R7P0S8QKHPV07VKXH65S3", "source_id": "01E7GZVZHBWYD50V00XDMYCMYP" }}'\-H"Content-Type: application/json"\-v -u{email_address}:{password}-X POST
Go
              
import("fmt""io""net/http""strings")funcmain(){url:="https://support.zendesk.com/api/v2/guide/external_content/records"method:="POST"payload:=strings.NewReader(`{"record": {"body": "We want to hear what you have to say about external content search, because ultimately we're building it for you. Below, you can find some guidelines on the best ways to let us know what you think. Right here -- this forum is the best place. With this format, we can respond to questions or comments so that everyone can see and benefit. We also encourage you to make it as social and collaborative as possible, so jump in if you have an idea that might help someone else.","external_id": "360046759835","locale": "en-us","source_id": "01E77R4513SKX3AE8H20Q0KJ1K","title": "How to leave feedback for Federated Help Center search","type_id": "01EBDWWC98ZF7DK9YQF3DK9Y77",:“url https://support.ze亚博ndesk.com/hc/en-us/community/posts/360046759834-How-to-leave-feedback-for-Federated-Help-Center-search","user_segment_id": "-1"}}`)req,err:=http.NewRequest(method,url,payload)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/guide/external_content/records").newBuilder();RequestBodybody=RequestBody.create(MediaType.parse("application/json"),"""{\"record\":{\"body\":\"Wewant to hear what you have to say about external content search,because ultimately we're building itforyou.Below,you can find some guidelines on the best ways toletus know what you think.Righthere--thisforumisthe best place.Withthisformat,we can respond to questions or comments so that everyone can see and benefit.Wealso encourage you to make itassocial and collaborativeaspossible,so jumpinifyou have an idea that might help someoneelse.\",\"external_id\":\"360046759835\",\"locale\":\"en-us\",\"source_id\":\"01E77R4513SKX3AE8H20Q0KJ1K\",\"title\":\"Howto leave feedbackforFederatedHelpCentersearch\",\"type_id\":\"01EBDWWC98ZF7DK9YQF3DK9Y77\",\"url\":\"https://support.亚博.com/hc/en-us/community/posts/360046759834-How-to-leave-feedback-for-Federated-Help-Center-search\",\"user_segment_id\":\"-1\"}}""");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');vardata=JSON.stringify({"record":{"body":"We want to hear what you have to say about external content search, because ultimately we're building it for you. Below, you can find some guidelines on the best ways to let us know what you think. Right here -- this forum is the best place. With this format, we can respond to questions or comments so that everyone can see and benefit. We also encourage you to make it as social and collaborative as possible, so jump in if you have an idea that might help someone else.","external_id":"360046759835","locale":"en-us","source_id":"01E77R4513SKX3AE8H20Q0KJ1K","title":"How to leave feedback for Federated Help Center search","type_id":"01EBDWWC98ZF7DK9YQF3DK9Y77","url":"https://support.zendesk.com/hc/en-us/community/posts/360046759834-How-to-leave-feedback-for-Federated-Help-Center-search","user_segment_id":"-1"}});varconfig={method:'POST',url:'https://support.zendesk.com/api/v2/guide/external_content/records',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},data:data,};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});
Python
              
importrequestsimportjsonurl="https://support.zendesk.com/api/v2/guide/external_content/records"payload=json.loads("""{"record": {"body": "We want to hear what you have to say about external content search, because ultimately we're building it for you. Below, you can find some guidelines on the best ways to let us know what you think. Right here -- this forum is the best place. With this format, we can respond to questions or comments so that everyone can see and benefit. We also encourage you to make it as social and collaborative as possible, so jump in if you have an idea that might help someone else.","external_id": "360046759835","locale": "en-us","source_id": "01E77R4513SKX3AE8H20Q0KJ1K","title": "How to leave feedback for Federated Help Center search","type_id": "01EBDWWC98ZF7DK9YQF3DK9Y77",:“url https://support.ze亚博ndesk.com/hc/en-us/community/posts/360046759834-How-to-leave-feedback-for-Federated-Help-Center-search","user_segment_id": "-1"}}""")headers={"Content-Type":"application/json",}response=requests.request("POST",url,auth=('',''),headers=headers,json=payload)print(response.text)
Ruby
              
require"net/http"uri=URI("https://support.zendesk.com/api/v2/guide/external_content/records")request=Net::HTTP::Post.new(uri,"Content-Type":"application/json")request.body=%q({"record":{"body":"We want to hear what you have to say about external content search, because ultimately we're building it for you. Below, you can find some guidelines on the best ways to let us know what you think. Right here -- this forum is the best place. With this format, we can respond to questions or comments so that everyone can see and benefit. We also encourage you to make it as social and collaborative as possible, so jump in if you have an idea that might help someone else.","external_id":"360046759835","locale":"en-us","source_id":"01E77R4513SKX3AE8H20Q0KJ1K","title":"How to leave feedback for Federated Help Center search","type_id":"01EBDWWC98ZF7DK9YQF3DK9Y77","url":"https://support.zendesk.com/hc/en-us/community/posts/360046759834-How-to-leave-feedback-for-Federated-Help-Center-search","user_segment_id":"-1"}})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{"record":{"body":"We want to hear what you have to say about external content search, because ultimately we're building it for you. Below, you can find some guidelines on the best ways to let us know what you think. Right here -- this forum is the best place. With this format, we can respond to questions or comments so that everyone can see and benefit. We also encourage you to make it as social and collaborative as possible, so jump in if you have an idea that might help someone else.","created_at":"2020-07-08T12:27:26Z","external_id":"360046759835","id":"01EC05A5T1J4ZSDJX4Q8JGFRHP","locale":"en-us","source":{"id":"01E77R4513SKX3AE8H20Q0KJ1K","name":"My Library"},"title":"How to leave feedback for Federated Help Center search","type":{"id":"01EBDWWC98ZF7DK9YQF3DK9Y77","name":"Blog"},"updated_at":"2020-07-08T12:27:26Z","url":"https://support.zendesk.com/hc/en-us/community/posts/360046759834-How-to-leave-feedback-for-Federated-Help-Center-search","user_segment_id":"-1"}}
401 Unauthorized
              
// Status 401 Unauthorized{"errors":[{"code":"Unauthorized","status":401,"title":"Feature not enabled"}]}
422 Unprocessable Entity
              
// Status 422 Unprocessable Entity{"errors":[{"code":"Invalid","status":422,"title":"Validation failed: External ID has already been taken"}]}

Update External Content Record

  • PUT /api/v2/guide/external_content/records/{id}

Updates the specified record with the request body.

Allowed For

  • Help Center managers

Parameters

Name Type In Required Description
id string Path true ULID for the object

Example body

             
{"record":{"body":"We want to hear what you have to say about external content search, because ultimately we're building it for you. Below, you can find some guidelines on the best ways to let us know what you think. Right here -- this forum is the best place. With this format, we can respond to questions or comments so that everyone can see and benefit. We also encourage you to make it as social and collaborative as possible, so jump in if you have an idea that might help someone else.","external_id":"360046759835","locale":"en-us","source_id":"01E77R4513SKX3AE8H20Q0KJ1K","title":"How to leave feedback for Federated Help Center search","type_id":"01EBDWWC98ZF7DK9YQF3DK9Y77","url":"https://support.zendesk.com/hc/en-us/community/posts/360046759834-How-to-leave-feedback-for-Federated-Help-Center-search","user_segment_id":"-1"}}

Code Samples

curl
              
curl"https://{subdomain}.zendesk.com/api/v2/guide/external_content/records/{id}"\-d'{ "record": { "title": "Mansfield Park", "url": "http://www.publicbookshelf.com/regency/mansfield-park/mansfieldpark8", "locale": "en-uk", "body": "Before his return Mrs. Grant and Miss Crawford came in.", "external_id": "mansfieldpark8", "user_segment_id": null, "type_id": "01E77R7P0S8QKHPV07VKXH65S3", "source_id": "01E7GZVZHBWYD50V00XDMYCMYP" }}'\-H"Content-Type: application/json"\-v -u{email_address}:{password}-X PUT
Go
              
import("fmt""io""net/http""strings")funcmain(){url:="https://support.zendesk.com/api/v2/guide/external_content/records/01E7GZVZHBWYD50V00XDMYCMYP"method:="PUT"payload:=strings.NewReader(`{"record": {"body": "We want to hear what you have to say about external content search, because ultimately we're building it for you. Below, you can find some guidelines on the best ways to let us know what you think. Right here -- this forum is the best place. With this format, we can respond to questions or comments so that everyone can see and benefit. We also encourage you to make it as social and collaborative as possible, so jump in if you have an idea that might help someone else.","external_id": "360046759835","locale": "en-us","source_id": "01E77R4513SKX3AE8H20Q0KJ1K","title": "How to leave feedback for Federated Help Center search","type_id": "01EBDWWC98ZF7DK9YQF3DK9Y77",:“url https://support.ze亚博ndesk.com/hc/en-us/community/posts/360046759834-How-to-leave-feedback-for-Federated-Help-Center-search","user_segment_id": "-1"}}`)req,err:=http.NewRequest(method,url,payload)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/guide/external_content/records/01E7GZVZHBWYD50V00XDMYCMYP").newBuilder();RequestBodybody=RequestBody.create(MediaType.parse("application/json"),"""{\"record\":{\"body\":\"Wewant to hear what you have to say about external content search,because ultimately we're building itforyou.Below,you can find some guidelines on the best ways toletus know what you think.Righthere--thisforumisthe best place.Withthisformat,we can respond to questions or comments so that everyone can see and benefit.Wealso encourage you to make itassocial and collaborativeaspossible,so jumpinifyou have an idea that might help someoneelse.\",\"external_id\":\"360046759835\",\"locale\":\"en-us\",\"source_id\":\"01E77R4513SKX3AE8H20Q0KJ1K\",\"title\":\"Howto leave feedbackforFederatedHelpCentersearch\",\"type_id\":\"01EBDWWC98ZF7DK9YQF3DK9Y77\",\"url\":\"https://support.亚博.com/hc/en-us/community/posts/360046759834-How-to-leave-feedback-for-Federated-Help-Center-search\",\"user_segment_id\":\"-1\"}}""");Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("PUT",body).addHeader("Content-Type","application/json").addHeader("Authorization",Credentials.basic("your-email","your-password")).build();Responseresponse=client.newCall(request).execute();
Nodejs
              
varaxios=require('axios');vardata=JSON.stringify({"record":{"body":"We want to hear what you have to say about external content search, because ultimately we're building it for you. Below, you can find some guidelines on the best ways to let us know what you think. Right here -- this forum is the best place. With this format, we can respond to questions or comments so that everyone can see and benefit. We also encourage you to make it as social and collaborative as possible, so jump in if you have an idea that might help someone else.","external_id":"360046759835","locale":"en-us","source_id":"01E77R4513SKX3AE8H20Q0KJ1K","title":"How to leave feedback for Federated Help Center search","type_id":"01EBDWWC98ZF7DK9YQF3DK9Y77","url":"https://support.zendesk.com/hc/en-us/community/posts/360046759834-How-to-leave-feedback-for-Federated-Help-Center-search","user_segment_id":"-1"}});varconfig={method:'PUT',url:'https://support.zendesk.com/api/v2/guide/external_content/records/01E7GZVZHBWYD50V00XDMYCMYP',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},data:data,};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});
Python
              
importrequestsimportjsonurl="https://support.zendesk.com/api/v2/guide/external_content/records/01E7GZVZHBWYD50V00XDMYCMYP"payload=json.loads("""{"record": {"body": "We want to hear what you have to say about external content search, because ultimately we're building it for you. Below, you can find some guidelines on the best ways to let us know what you think. Right here -- this forum is the best place. With this format, we can respond to questions or comments so that everyone can see and benefit. We also encourage you to make it as social and collaborative as possible, so jump in if you have an idea that might help someone else.","external_id": "360046759835","locale": "en-us","source_id": "01E77R4513SKX3AE8H20Q0KJ1K","title": "How to leave feedback for Federated Help Center search","type_id": "01EBDWWC98ZF7DK9YQF3DK9Y77",:“url https://support.ze亚博ndesk.com/hc/en-us/community/posts/360046759834-How-to-leave-feedback-for-Federated-Help-Center-search","user_segment_id": "-1"}}""")headers={"Content-Type":"application/json",}response=requests.request("PUT",url,auth=('',''),headers=headers,json=payload)print(response.text)
Ruby
              
require"net/http"uri=URI("https://support.zendesk.com/api/v2/guide/external_content/records/01E7GZVZHBWYD50V00XDMYCMYP")request=Net::HTTP::Put.new(uri,"Content-Type":"application/json")request.body=%q({"record":{"body":"We want to hear what you have to say about external content search, because ultimately we're building it for you. Below, you can find some guidelines on the best ways to let us know what you think. Right here -- this forum is the best place. With this format, we can respond to questions or comments so that everyone can see and benefit. We also encourage you to make it as social and collaborative as possible, so jump in if you have an idea that might help someone else.","external_id":"360046759835","locale":"en-us","source_id":"01E77R4513SKX3AE8H20Q0KJ1K","title":"How to leave feedback for Federated Help Center search","type_id":"01EBDWWC98ZF7DK9YQF3DK9Y77","url":"https://support.zendesk.com/hc/en-us/community/posts/360046759834-How-to-leave-feedback-for-Federated-Help-Center-search","user_segment_id":"-1"}})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{"record":{"body":"We want to hear what you have to say about external content search, because ultimately we're building it for you. Below, you can find some guidelines on the best ways to let us know what you think. Right here -- this forum is the best place. With this format, we can respond to questions or comments so that everyone can see and benefit. We also encourage you to make it as social and collaborative as possible, so jump in if you have an idea that might help someone else.","created_at":"2020-07-08T12:27:26Z","external_id":"360046759835","id":"01EC05A5T1J4ZSDJX4Q8JGFRHP","locale":"en-us","source":{"id":"01E77R4513SKX3AE8H20Q0KJ1K","name":"My Library"},"title":"How to leave feedback for Federated Help Center search","type":{"id":"01EBDWWC98ZF7DK9YQF3DK9Y77","name":"Blog"},"updated_at":"2020-07-08T12:27:26Z","url":"https://support.zendesk.com/hc/en-us/community/posts/360046759834-How-to-leave-feedback-for-Federated-Help-Center-search","user_segment_id":"-1"}}

删除External Content Record

  • DELETE /api/v2/guide/external_content/records/{id}

删除s the specified record.

Allowed For

  • Help Center managers

Parameters

Name Type In Required Description
id string Path true ULID for the object

Code Samples

curl
              
curlhttps://{subdomain}.zendesk.com/api/v2/guide/external_content/records/{id}\-v -u{email_address}:{password}-X DELETE
Go
              
import("fmt""io""net/http")funcmain(){url:="https://support.zendesk.com/api/v2/guide/external_content/records/01E7GZVZHBWYD50V00XDMYCMYP"method:="DELETE"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/guide/external_content/records/01E7GZVZHBWYD50V00XDMYCMYP").newBuilder();Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("DELETE",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:'DELETE',url:'https://support.zendesk.com/api/v2/guide/external_content/records/01E7GZVZHBWYD50V00XDMYCMYP',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/guide/external_content/records/01E7GZVZHBWYD50V00XDMYCMYP"headers={"Content-Type":"application/json",}response=requests.request("DELETE",url,auth=('',''),headers=headers)print(response.text)
Ruby
              
require"net/http"uri=URI("https://support.zendesk.com/api/v2/guide/external_content/records/01E7GZVZHBWYD50V00XDMYCMYP")request=Net::HTTP::删除.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)

204 No Content
              
// Status 204 No Contentnull