Send the forwarding test message to verify@<domain>

POST

/v1/domains/{id}/forwarding-test

const url = 'https://api.fromenance.com/v1/domains/dom_01J8Z9X0Q3K4M5N6P7R8S9T0V1/forwarding-test';
const options = {
  method: 'POST',
  headers: {cookie: 'fromenance.session_token=<fromenance.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.fromenance.com/v1/domains/dom_01J8Z9X0Q3K4M5N6P7R8S9T0V1/forwarding-test \
  --cookie fromenance.session_token=<fromenance.session_token>

The message carries a token. When the tenant’s redirect rule delivers it to the tenant inbox with a DKIM or ARC pass for the domain, the rule is marked Working. Poll GET on the same path.

Authorizations

Session
ApiKey

Parameters

Path Parameters

required

string

/^dom_[0-9A-Z]{26}$/

Example

dom_01J8Z9X0Q3K4M5N6P7R8S9T0V1

Responses

200

Status

application/json

object

status

required

string

Allowed values: not_started sent working failed

sent_at

required

string | null

passed_at

required

string | null

result

required

string | null

required

string

Example

{
  "status": "not_started"
}