Classic ASP / Support API / Update a Sharing Agreement
Back to Collection Items
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<%
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = Server.CreateObject("Chilkat.Http")
http.BasicAuth = 1
http.Login = "login"
http.Password = "password"
http.SetRequestHeader "Accept","application/json"
' resp is a Chilkat.HttpResponse
Set resp = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/sharing_agreements/:sharing_agreement_id")
If (http.LastMethodSuccess = 0) Then
Response.Write "<pre>" & Server.HTMLEncode( http.LastErrorText) & "</pre>"
Response.End
End If
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = Server.CreateObject("Chilkat.StringBuilder")
success = resp.GetBodySb(sbResponseBody)
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = Server.CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Response.Write "<pre>" & Server.HTMLEncode( "Response Body:") & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( jResp.Emit()) & "</pre>"
respStatusCode = resp.StatusCode
Response.Write "<pre>" & Server.HTMLEncode( "Response Status Code = " & respStatusCode) & "</pre>"
If (respStatusCode >= 400) Then
Response.Write "<pre>" & Server.HTMLEncode( "Response Header:") & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( resp.Header) & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( "Failed.") & "</pre>"
Response.End
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "sharing_agreement": {
' "created_at": "<dateTime>",
' "id": "<integer>",
' "name": "<string>",
' "partner_name": "<string>",
' "remote_subdomain": "<string>",
' "status": "<string>",
' "type": "<string>",
' "url": "<string>"
' }
' }
' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Created_at = jResp.StringOf("sharing_agreement.created_at")
Id = jResp.StringOf("sharing_agreement.id")
Name = jResp.StringOf("sharing_agreement.name")
Partner_name = jResp.StringOf("sharing_agreement.partner_name")
Remote_subdomain = jResp.StringOf("sharing_agreement.remote_subdomain")
Status = jResp.StringOf("sharing_agreement.status")
v_Type = jResp.StringOf("sharing_agreement.type")
v_Url = jResp.StringOf("sharing_agreement.url")
%>
</body>
</html>
Curl Command
curl -u login:password -X PUT
-H "Accept: application/json"
https://example.zendesk.com/api/v2/sharing_agreements/:sharing_agreement_id
Postman Collection Item JSON
{
"name": "Update a Sharing Agreement",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sharing_agreements/:sharing_agreement_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sharing_agreements",
":sharing_agreement_id"
],
"variable": [
{
"key": "sharing_agreement_id",
"value": "<integer>"
}
]
},
"description": "Returns an updated sharing agreement. Only `status` is allowed to be updated.\n\n#### Allowed For\n\n* Admins\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sharing_agreements/:sharing_agreement_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sharing_agreements",
":sharing_agreement_id"
],
"variable": [
{
"key": "sharing_agreement_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"sharing_agreement\": {\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"partner_name\": \"<string>\",\n \"remote_subdomain\": \"<string>\",\n \"status\": \"<string>\",\n \"type\": \"<string>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}
