PUT /api/v2/recipient_addresses/{support_address_id}/verify
Sends a test email to the specified support address to verify that email forwarding for the address works. An external support address won't work in Zendesk Support until it's verified.
Note: You don't need to verify Zendesk system support addresses.
The endpoint takes the following body: {"type": "forwarding"}. The value of the type property defaults to "forwarding" if none is specified, but the values "spf" and "dns" are also accepted.
Use this endpoint after adding an external support address to Zendesk Support and setting up forwarding on your email server. See Forwarding incoming email to Zendesk Support.
The endpoint doesn't return the results of the test. Instead, use the Show Support Address endpoint to check that the forwarding_status property is "verified".
Other verification checks can also be performed using this API. These include SPF checks and DNS checks.
When calling the endpoint with type set to "spf", it will queries the DNS records to check that the SPF records for Zendesk are present for outbound emails.
When calling the endpoint with type set to "dns", it runs checks on your CNAME records to make sure they are set up properly in your DNS.
Allowed For
- Admins
- Agents with permission to manage channels and extensions. See the system permissions in Creating custom roles and assigning agents (Enterprise) in the Support Help Center
Servers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
support_address_id |
Integer | Yes |
The ID of the support address |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.