SQL Server / Support API / Create Support Address
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', 'login'
EXEC sp_OASetProperty @http, 'Password', 'password'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequest', @resp OUT, 'POST', 'https://example.zendesk.com/api/v2/recipient_addresses'
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @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
DECLARE @v_Email nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Email OUT, 'recipient_address.email'
DECLARE @Brand_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Brand_id OUT, 'recipient_address.brand_id'
DECLARE @Cname_status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Cname_status OUT, 'recipient_address.cname_status'
DECLARE @Created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'recipient_address.created_at'
DECLARE @Default nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Default OUT, 'recipient_address.default'
DECLARE @Dns_results nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Dns_results OUT, 'recipient_address.dns_results'
DECLARE @Domain_verification_code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Domain_verification_code OUT, 'recipient_address.domain_verification_code'
DECLARE @Domain_verification_status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Domain_verification_status OUT, 'recipient_address.domain_verification_status'
DECLARE @Forwarding_status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Forwarding_status OUT, 'recipient_address.forwarding_status'
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'recipient_address.id'
DECLARE @Name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'recipient_address.name'
DECLARE @Spf_status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Spf_status OUT, 'recipient_address.spf_status'
DECLARE @Updated_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Updated_at OUT, 'recipient_address.updated_at'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
