Email White Label - Get (Mandrill status)

Overview

Returns the company's email white-label record plus live Mandrill verification status. Loads the latest VerifiedEmail for company_id, then queries Mandrill for sender-domain verification (/senders/verify-domain, /senders/check-domain) and tracking-domain status (/urls/check-tracking-domain, auto-adding it via /urls/add-tracking-domain if unknown), and includes the platform default sender settings.

Prerequisites

A bearer token. Callable with Partner and Account tokens.

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

Requires a bearer token in the Authorization: Bearer <bearer-token> header.
Who can call it: Partner and Account tokens.
Authentication, role-agnostic account/white-label prefix.
company_id is required and scoped by an ownership check (must be in the caller's hierarchy).
A partner can read any company beneath it. An account user only its own part of the account tree.
Invalid/out-of-hierarchy ids return 422.

Rate limit

No rate limit.

Request body

Body:

Field	Type	Required	Description
`company_id`	integer	required	Must be an existing account inside your own account tree.

{
  "company_id": 5
}

Response

data.status (string) — "success".
data.data (object|null) — the VerifiedEmail row (id, company_id, email, name, domain, tracking_url, domain_verified_at, url_verified_at, timestamps), or null if none.
data.verification (object) — verify_domain, check_domain, check_tracking_domain (raw Mandrill responses; empty objects when no model/domain), and default_settings (email, name, tracking_url from config('mail.*')).
data.instruction_file (string) — versioned asset URL to the email-setup PDF.

200 OK · `200`

{
  "data": {
    "status": "success",
    "data": {
      "id": 1,
      "company_id": 5,
      "email": "[email protected]",
      "name": "hipages",
      "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": "Review Management",
        "tracking_url": "track.shoutaboutus.com"
      }
    },
    "instruction_file": "https://production-api.shoutaboutus.com/assets/sample/RM White Label Email Setup Instructions.pdf?v=<redacted>"
  }
}

422 Unprocessable Entity · `422`

{
  "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."
    ]
  }
}

Errors

Status	Meaning
`401`	The bearer token is missing, expired or invalid
`422`	Unprocessable Entity
`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": 5}'

Updated 8 days ago

Did this page help you?