Chilkat Online Tools

Foxpro / Support API / Create Support Address

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcV_Email
LOCAL lcBrand_id
LOCAL lcCname_status
LOCAL lcCreated_at
LOCAL lcDefault
LOCAL lcDns_results
LOCAL lcDomain_verification_code
LOCAL lcDomain_verification_status
LOCAL lcForwarding_status
LOCAL lcId
LOCAL lcName
LOCAL lcSpf_status
LOCAL lcUpdated_at

* 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')
loHttp = CreateObject('Chilkat.Http')

loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"

loHttp.SetRequestHeader("Accept","application/json")

loResp = loHttp.QuickRequest("POST","https://example.zendesk.com/api/v2/recipient_addresses")
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* 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

lcV_Email = loJResp.StringOf("recipient_address.email")
lcBrand_id = loJResp.StringOf("recipient_address.brand_id")
lcCname_status = loJResp.StringOf("recipient_address.cname_status")
lcCreated_at = loJResp.StringOf("recipient_address.created_at")
lcDefault = loJResp.StringOf("recipient_address.default")
lcDns_results = loJResp.StringOf("recipient_address.dns_results")
lcDomain_verification_code = loJResp.StringOf("recipient_address.domain_verification_code")
lcDomain_verification_status = loJResp.StringOf("recipient_address.domain_verification_status")
lcForwarding_status = loJResp.StringOf("recipient_address.forwarding_status")
lcId = loJResp.StringOf("recipient_address.id")
lcName = loJResp.StringOf("recipient_address.name")
lcSpf_status = loJResp.StringOf("recipient_address.spf_status")
lcUpdated_at = loJResp.StringOf("recipient_address.updated_at")

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

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}"
    }
  ]
}