Get email sender status

Overview

See whether your sending domain is verified so emails go out from your address.

Use this to check setup.

You'll need a partner or account token.

Returns the domain and its verification status. When no sender is set up, data is null, the three checks are empty arrays, and default_settings shows the platform sender used meanwhile.

Prerequisites

A bearer token. See Authentication.
The account's id (company_id).

Base URL

Environment	URL
Production	`https://production-api.shoutaboutus.com`
Development	`https://development-api.shoutaboutus.com`

Endpoint

POST /api/v1/account/white-label/email

Authentication

Partner or Account token

company_id must be inside your own account tree. A Partner token can use any account under the partner; an Account token only its own account.
An account outside your tree, or one that doesn't exist, is rejected with 422.

Rate limit

This endpoint has no rate limit.

Request parameters

None.

Request body

Field	Type	Required	Description
`company_id`	integer	Yes	The account. Must exist and be inside your account tree.

Request payload

{
  "company_id": 5994
}

Response body

The payload is inside data.

Field	Type	Description
`status`	string	`success`.
`data`	object or null	The account's latest sender, or `null` when none is set up.
`data.id`	integer	The sender record's id.
`data.company_id`	integer	The account.
`data.email`	string	The sender address.
`data.name`	string	The sender name.
`data.domain`	string	The sender address's domain.
`data.tracking_url`	string	The tracking domain.
`data.domain_verified_at`	string or null	When the sending domain was verified; `null` until then.
`data.url_verified_at`	string or null	When the tracking domain was verified; `null` until then.
`data.created_at`	string	When the sender was added (ISO 8601).
`data.updated_at`	string	When it was last changed (ISO 8601).
`data.deleted_at`	string or null	`null`.
`verification`	object	The verification checks.
`verification.verify_domain`	object or array	The email provider's domain verification result (e.g. `status`: `already_verified`). An empty array `[]` when no sender is set up.
`verification.check_domain`	object or array	The email provider's DNS check for the sending domain (`spf`, `dkim`, `dkim2`, `dmarc`, `valid_signing`, ...). `[]` when no sender is set up.
`verification.check_tracking_domain`	object or array	The email provider's check of the tracking domain (`cname`, `valid_tracking`, ...). `[]` when no sender is set up.
`verification.default_settings`	object	The platform sender used until yours is verified.
`verification.default_settings.email`	string	Default sender address.
`verification.default_settings.name`	string	Default sender name.
`verification.default_settings.tracking_url`	string	Default tracking domain.
`instruction_file`	string	URL of the email setup instructions (PDF).

Response payload

{
  "data": {
    "status": "success",
    "data": {
      "id": 1,
      "company_id": 5994,
      "email": "[email protected]",
      "name": "Acme Reviews",
      "domain": "manage-myreviews.com",
      "tracking_url": "track.manage-myreviews.com",
      "domain_verified_at": "2026-06-11T11:53:59.000000Z",
      "url_verified_at": "2026-06-11T11:53:59.000000Z",
      "deleted_at": null,
      "created_at": "2026-06-11T11:53:59.000000Z",
      "updated_at": "2026-06-11T11:53:59.000000Z"
    },
    "verification": {
      "verify_domain": {
        "status": "already_verified",
        "domain": "manage-myreviews.com",
        "email": "[email protected]"
      },
      "check_domain": {
        "domain": "manage-myreviews.com",
        "created_at": "2026-05-27 10:56:00",
        "last_tested_at": "2026-06-16 11:11:27",
        "spf": {
          "valid": true,
          "valid_after": null,
          "error": null
        },
        "dkim": {
          "valid": true,
          "valid_after": null,
          "error": null
        },
        "dkim2": {
          "valid": true,
          "valid_after": null,
          "error": null
        },
        "dmarc": {
          "valid": true,
          "error": null
        },
        "verified_at": "2026-06-16 11:11:27",
        "valid_signing": true,
        "verify_txt_key": "<redacted>"
      },
      "check_tracking_domain": {
        "domain": "track.manage-myreviews.com",
        "created_at": "2026-05-27 11:04:37.62299",
        "last_tested_at": "2026-06-16 11:11:28.28119",
        "cname": {
          "valid": true,
          "valid_after": null,
          "error": null
        },
        "valid_tracking": true
      },
      "default_settings": {
        "email": "[email protected]",
        "name": "Shout About Us",
        "tracking_url": "track.shoutaboutus.com"
      }
    },
    "instruction_file": "https://production-api.shoutaboutus.com/assets/sample/RM White Label Email Setup Instructions.pdf?v=1790873663"
  }
}

Examples

Success payload

Sender set up and verified: see Response payload.

No sender set up yet:

{
  "data": {
    "status": "success",
    "data": null,
    "verification": {
      "verify_domain": [],
      "check_domain": [],
      "check_tracking_domain": [],
      "default_settings": {
        "email": "[email protected]",
        "name": "Shout About Us",
        "tracking_url": "track.shoutaboutus.com"
      }
    },
    "instruction_file": "https://production-api.shoutaboutus.com/assets/sample/RM White Label Email Setup Instructions.pdf?v=1790873663"
  }
}

Error payload

422 company_id is missing

{
  "message": "The company id field is required.",
  "errors": {
    "company_id": [
      "The company id field is required."
    ]
  }
}

422 Account outside your tree

{
  "message": "The selected company id does not belong to your company hierarchy.",
  "errors": {
    "company_id": [
      "The selected company id does not belong to your company hierarchy."
    ]
  }
}

422 Account doesn't exist

{
  "message": "The selected company id is invalid. (and 1 more error)",
  "errors": {
    "company_id": [
      "The selected company id is invalid.",
      "The selected company id does not belong to your company hierarchy."
    ]
  }
}

Status	Meaning
`200`	The sender's verification status.
`401`	The token is missing, expired or invalid.
`422`	`company_id` is missing, doesn't exist or is outside your tree.
`500`	Unexpected server error.

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/account/white-label/email" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"company_id": 5994}'