Organisations
Send a test email through one connector
Sends a short email through the connector to the person asking, with no fallback, and answers whether the provider took it.
POST
/orgs/{org}/connectors/email/{provider}/testTL;DR
| Question | Answer |
|---|---|
| What does it do? | Send a test email through one connector. |
| What does it take? | org, provider in the path. |
| What does it return? | Status 200 with a body of type OrgConnectorTest. |
| What can go wrong? | 401 not signed in; 403 not the owner or an admin, the plan has no connectors, or the origin may not make changes; 404 no such organisation, the caller is not a member of it, or no connector for that provider; 409 the stored token can no longer be opened (connectors.token_unreadable); 429 too many requests; 503 this server cannot keep a token (connectors.unavailable). Every failure uses the one error envelope. |
What it does
Sends a short email through the connector to the person asking, with no fallback, and answers whether the provider took it.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
provider | "resend" | "sendgrid" | "postmark" | "mailgun" | "brevo" | yes | The email provider: resend, sendgrid, postmark, mailgun or brevo. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | Whether the provider took it. | OrgConnectorTest |
| 401 | Not signed in. | ErrorResponse |
| 403 | Not the owner or an admin, the plan has no connectors, or the origin may not make changes. | ErrorResponse |
| 404 | No such organisation, the caller is not a member of it, or no connector for that provider. | ErrorResponse |
| 409 | The stored token can no longer be opened (connectors.token_unreadable). | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | This server cannot keep a token (connectors.unavailable). | ErrorResponse |
Response body
A 200 answer has the type OrgConnectorTest.
| Field | Type | Required | Description |
|---|---|---|---|
ok | boolean | yes | |
reason | string | null | yes | |
to | string | yes |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |