Chilkat Online Tools

VB6 / Support API / Update Support Address

Back to Collection Items

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As New ChilkatHttp
Dim success As Long

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

http.SetRequestHeader "Accept","application/json"

Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/recipient_addresses/:support_address_id")
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

' 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

Dim v_Email As String
v_Email = jResp.StringOf("recipient_address.email")
Dim Brand_id As String
Brand_id = jResp.StringOf("recipient_address.brand_id")
Dim Cname_status As String
Cname_status = jResp.StringOf("recipient_address.cname_status")
Dim Created_at As String
Created_at = jResp.StringOf("recipient_address.created_at")
Dim Default As String
Default = jResp.StringOf("recipient_address.default")
Dim Dns_results As String
Dns_results = jResp.StringOf("recipient_address.dns_results")
Dim Domain_verification_code As String
Domain_verification_code = jResp.StringOf("recipient_address.domain_verification_code")
Dim Domain_verification_status As String
Domain_verification_status = jResp.StringOf("recipient_address.domain_verification_status")
Dim Forwarding_status As String
Forwarding_status = jResp.StringOf("recipient_address.forwarding_status")
Dim Id As String
Id = jResp.StringOf("recipient_address.id")
Dim Name As String
Name = jResp.StringOf("recipient_address.name")
Dim Spf_status As String
Spf_status = jResp.StringOf("recipient_address.spf_status")
Dim Updated_at As String
Updated_at = jResp.StringOf("recipient_address.updated_at")

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