unicodeC / Support API / Update Support Address
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *v_Email;
const wchar_t *Brand_id;
const wchar_t *Cname_status;
const wchar_t *Created_at;
const wchar_t *Default;
const wchar_t *Dns_results;
const wchar_t *Domain_verification_code;
const wchar_t *Domain_verification_status;
const wchar_t *Forwarding_status;
const wchar_t *Id;
const wchar_t *Name;
const wchar_t *Spf_status;
const wchar_t *Updated_at;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
CkHttpW_putBasicAuth(http,TRUE);
CkHttpW_putLogin(http,L"login");
CkHttpW_putPassword(http,L"password");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
resp = CkHttpW_QuickRequest(http,L"PUT",L"https://example.zendesk.com/api/v2/recipient_addresses/:support_address_id");
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
v_Email = CkJsonObjectW_stringOf(jResp,L"recipient_address.email");
Brand_id = CkJsonObjectW_stringOf(jResp,L"recipient_address.brand_id");
Cname_status = CkJsonObjectW_stringOf(jResp,L"recipient_address.cname_status");
Created_at = CkJsonObjectW_stringOf(jResp,L"recipient_address.created_at");
Default = CkJsonObjectW_stringOf(jResp,L"recipient_address.default");
Dns_results = CkJsonObjectW_stringOf(jResp,L"recipient_address.dns_results");
Domain_verification_code = CkJsonObjectW_stringOf(jResp,L"recipient_address.domain_verification_code");
Domain_verification_status = CkJsonObjectW_stringOf(jResp,L"recipient_address.domain_verification_status");
Forwarding_status = CkJsonObjectW_stringOf(jResp,L"recipient_address.forwarding_status");
Id = CkJsonObjectW_stringOf(jResp,L"recipient_address.id");
Name = CkJsonObjectW_stringOf(jResp,L"recipient_address.name");
Spf_status = CkJsonObjectW_stringOf(jResp,L"recipient_address.spf_status");
Updated_at = CkJsonObjectW_stringOf(jResp,L"recipient_address.updated_at");
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(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}"
}
]
}
