PowerBuilder / Support API / Update Support Address
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_V_Email
string ls_Brand_id
string ls_Cname_status
string ls_Created_at
string ls_Default
string ls_Dns_results
string ls_Domain_verification_code
string ls_Domain_verification_status
string ls_Forwarding_status
string ls_Id
string ls_Name
string ls_Spf_status
string ls_Updated_at
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "login"
loo_Http.Password = "password"
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = loo_Http.QuickRequest("PUT","https://example.zendesk.com/api/v2/recipient_addresses/:support_address_id")
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "recipient_address": {
// "email": "<string>",
// "brand_id": "<integer>",
// "cname_status": "unknown",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "dns_results": "verified",
// "domain_verification_code": "<string>",
// "domain_verification_status": "failed",
// "forwarding_status": "unknown",
// "id": "<integer>",
// "name": "<string>",
// "spf_status": "unknown",
// "updated_at": "<dateTime>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_V_Email = loo_JResp.StringOf("recipient_address.email")
ls_Brand_id = loo_JResp.StringOf("recipient_address.brand_id")
ls_Cname_status = loo_JResp.StringOf("recipient_address.cname_status")
ls_Created_at = loo_JResp.StringOf("recipient_address.created_at")
ls_Default = loo_JResp.StringOf("recipient_address.default")
ls_Dns_results = loo_JResp.StringOf("recipient_address.dns_results")
ls_Domain_verification_code = loo_JResp.StringOf("recipient_address.domain_verification_code")
ls_Domain_verification_status = loo_JResp.StringOf("recipient_address.domain_verification_status")
ls_Forwarding_status = loo_JResp.StringOf("recipient_address.forwarding_status")
ls_Id = loo_JResp.StringOf("recipient_address.id")
ls_Name = loo_JResp.StringOf("recipient_address.name")
ls_Spf_status = loo_JResp.StringOf("recipient_address.spf_status")
ls_Updated_at = loo_JResp.StringOf("recipient_address.updated_at")
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -u login:password -X PUT
-H "Accept: application/json"
https://example.zendesk.com/api/v2/recipient_addresses/:support_address_id
Postman Collection Item JSON
{
"name": "Update Support Address",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/recipient_addresses/:support_address_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"recipient_addresses",
":support_address_id"
],
"variable": [
{
"key": "support_address_id",
"value": "<integer>"
}
]
},
"description": "Updates an existing support address for your account.\n\nYou can't use this endpoint to update a support address's `email` property.\nInstead, you can create a new address using the [Create Support\nAddress](#create-support-address) endpoint.\n\n#### Allowed For\n\n* Admins\n* Agents with permission to manage channels and extensions. See the system permissions in [Creating custom roles and assigning agents (Enterprise)](https://support.zendesk.com/hc/en-us/articles/203662026-Creating-custom-roles-and-assigning-agents-Enterprise-#topic_cxn_hig_bd) in the Support Help Center\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/recipient_addresses/:support_address_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"recipient_addresses",
":support_address_id"
],
"variable": [
{
"key": "support_address_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"recipient_address\": {\n \"email\": \"<string>\",\n \"brand_id\": \"<integer>\",\n \"cname_status\": \"unknown\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"dns_results\": \"verified\",\n \"domain_verification_code\": \"<string>\",\n \"domain_verification_status\": \"failed\",\n \"forwarding_status\": \"unknown\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"spf_status\": \"unknown\",\n \"updated_at\": \"<dateTime>\"\n }\n}"
}
]
}
