Skip to main content
POST
/
comms
/
v1
/
api
/
comms
/
domain
Start domain authentication for the calling user.
curl --request POST \
  --url https://api.qflowhub.io/comms/v1/api/comms/domain \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>' \
  --data '
{
  "domain": "<string>"
}
'
{
  "id": 123,
  "domain": "<string>",
  "verified": true,
  "enabled": true,
  "dnsRecords": [
    {
      "type": "<string>",
      "host": "<string>",
      "data": "<string>",
      "valid": true
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.qflowhub.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 access token issued by https://identity.qflowhub.io/core. Include as Authorization: Bearer <token>. See the Authentication guide for the token flow.

​
Ocp-Apim-Subscription-Key
string
header
required

Your APIM subscription key. Sent in the welcome email when your account is enabled. Required on every request alongside the bearer token.

Body

Request body for POST /api/comms/domain.

​
domain
string
required

Domain to authenticate (e.g. mail.example.com). SendGrid generates DNS records you publish at your registrar; once verified, emails sent from this user use the custom domain automatically.

Response

OK

Response shape for GET /api/comms/domain, POST /api/comms/domain, and the activate/deactivate endpoints.

​
id
integer<int64>

SendGrid's id for this domain authentication record.

​
domain
string
​
verified
boolean

True once SendGrid has verified your DNS records.

​
enabled
boolean

True when this user's sends route through the custom domain. Set automatically on first successful verify; toggle via /activate and /deactivate.

​
dnsRecords
object[]

DNS records you must publish at your registrar (CNAMEs, etc.). Each record's valid flag becomes true once SendGrid sees it propagated.