API reference
Set domain web forwarding
POST
Read owned domains and run bounded public availability checks.
Separately gated. verified confirms a matching Cloudflare rule; public DNS/HTTP delivery remains unverified. Concurrent changes can supersede the target. Inspect the result before retrying.
Required scope: domains:forwarding:write.
bearerAuthheader
AuthorizationBearer <token>Scoped GoodInboxes API token
id*stringOwned resource UUID.
application/json- body
targetUrl*stringPublic HTTP(S) forwarding destination, up to 2048 characters.
consent*booleanExplicit true after approval of this domain and destination.
data.id, data.targetUrl, data.status, data.checkedAt and data.verificationSource
application/json- response
data*data.id, data.targetUrl, data.status, data.checkedAt and data.verificationSource
requestId?stringcurl -X POST "https://example.com/api/v1/domains/string/forwarding" \ -H "Content-Type: application/json" \ -d '{ "targetUrl": "string", "consent": true }'{ "data": {}, "requestId": "string"}