API Reference

Refresh DNS Records

patch
https://app.mailivery.io/api/v1/campaigns//refreshDns

Triggers an async re-check of the SPF, DMARC, and MX DNS records for the campaign's sending domain, and polls the result of a previously queued refresh.

Two-phase usage

Phase 1 – Trigger a refresh

Send a PATCH request without a refresh_id body parameter. Mailivery will queue the DNS check job and return a 202 with an encrypted refresh_id token.

Phase 2 – Poll the result

Repeat the same PATCH request, this time including the refresh_id from Phase 1. Poll at a reasonable interval (e.g. every 3–5 seconds) until the response code is REFRESH_DNS_COMPLETED or an error is returned.

Rate limiting

Each campaign domain may only trigger a new refresh once every 30 minutes. Subsequent trigger requests within that window return 429 TOO_MANY_REQUESTS. Polling an existing refresh_id is not rate-limited.

Path Params
integer
required

Campaign Id

Form Data
string

Encrypted token returned by the Phase 1 (trigger) response. When present, the endpoint polls the status of the queued job instead of queuing a new one.

Headers
string
required

Any Uniquie string, timestap or UUID for Logging

string
required
Defaults to application/json

Expected Type for response

Responses

Updated 1 day ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 1 day ago