DataFlex / Support API / Create Support Address
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sV_Email
String sBrand_id
String sCname_status
String sCreated_at
String sDefault
String sDns_results
String sDomain_verification_code
String sDomain_verification_status
String sForwarding_status
String sId
String sName
String sSpf_status
String sUpdated_at
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Set ComBasicAuth Of hoHttp To True
Set ComLogin Of hoHttp To "login"
Set ComPassword Of hoHttp To "password"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get ComQuickRequest Of hoHttp "POST" "https://example.zendesk.com/api/v2/recipient_addresses" To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get ComStringOf Of hoJResp "recipient_address.email" To sV_Email
Get ComStringOf Of hoJResp "recipient_address.brand_id" To sBrand_id
Get ComStringOf Of hoJResp "recipient_address.cname_status" To sCname_status
Get ComStringOf Of hoJResp "recipient_address.created_at" To sCreated_at
Get ComStringOf Of hoJResp "recipient_address.default" To sDefault
Get ComStringOf Of hoJResp "recipient_address.dns_results" To sDns_results
Get ComStringOf Of hoJResp "recipient_address.domain_verification_code" To sDomain_verification_code
Get ComStringOf Of hoJResp "recipient_address.domain_verification_status" To sDomain_verification_status
Get ComStringOf Of hoJResp "recipient_address.forwarding_status" To sForwarding_status
Get ComStringOf Of hoJResp "recipient_address.id" To sId
Get ComStringOf Of hoJResp "recipient_address.name" To sName
Get ComStringOf Of hoJResp "recipient_address.spf_status" To sSpf_status
Get ComStringOf Of hoJResp "recipient_address.updated_at" To sUpdated_at
End_Procedure
Curl Command
curl -u login:password -X POST
-H "Accept: application/json"
https://example.zendesk.com/api/v2/recipient_addresses
Postman Collection Item JSON
{
"name": "Create Support Address",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/recipient_addresses",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"recipient_addresses"
]
},
"description": "Adds a Zendesk or external support address to your account.\n\nTo add a Zendesk address, use the following syntax: `{local-part}@{accountname}.zendesk.com`.\nExample: 'sales-team@example.zendesk.com'. The [local-part](https://en.wikipedia.org/wiki/Email_address#Local-part) can be anything you like.\n\nTo add an external email address such as help@omniwearshop.com, the email must already exist and you must set up forwarding on your email server. The exact steps depend on your mail server. See [Forwarding incoming email to Zendesk Support](https://support.zendesk.com/hc/en-us/articles/203663266). After setting up forwarding, run the [Verify Support Address Forwarding](#verify-support-address-forwarding) endpoint. The address won't work in Zendesk Support until it's been verified.\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": "Created response",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/recipient_addresses",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"recipient_addresses"
]
}
},
"status": "Created",
"code": 201,
"_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}"
}
]
}
