Use POST /v2/domains/{domainId}/sync to request immediate reconciliation of an owned domain. Synchronization refreshes state; it does not register, renew, restore or transfer a domain on its own.
IN THIS ARTICLE
01 Decide when to synchronize
Use sync when a provider operation has finished but your local record needs refresh, when troubleshooting a stale expiry or when an authorised change occurred outside the normal interface. Keep routine scheduled synchronization enabled for your connector instead of issuing aggressive refreshes for every page view.
- Resolve the domain's current identifier and read its stored state.
- Check for an existing pending operation so you understand what sync is expected to reconcile.
- Authenticate with
domains:syncand submit the route with an idempotency key. - Retain the returned operation or job reference and follow its result.
POST /v2/domains/DOMAIN_ID/sync
Idempotency-Key: sync-domain-review-1042
Content-Type: application/json
{}02 Verify the refreshed data
After completion, reread GET /v2/domains/DOMAIN_ID and the specific status you needed, such as lock or transfer state. Compare expiry with the actual provider outcome rather than adding an assumed year locally.
A sync response can still be queued, and a provider outage can prevent fresh data. An unchanged value after a failed sync is not proof that the provider rejected the earlier business operation.
03 Keep separate systems distinct
Registrar state, authoritative DNS and your customer's billing schedule are related but separate. Domain sync does not copy DNS records between providers or change registrar nameservers to a hosting package's master. It also does not turn a paid retail invoice into proof of upstream registration.
For transfer monitoring, read the dedicated transfer state and original operation. For public DNS, query the parent delegation and authoritative records.
Should I repeat a paid operation when domain synchronization fails?
If the request times out, inspect its reference before retrying. Use the original idempotency key for an unchanged transport retry. Do not call register or renew as a workaround for stale displayed information.
When escalation is needed, provide the domain, last known expiry/status, operation and sync references, and when the outside change occurred. This gives support a precise reconciliation target.