Send linked email

POST/api/email/send

Sends an outbound email through a linked workspace email account.

Request Body

application/json

Request payload for Send linked email.

TypeScript Definitions

Use the request body type in TypeScript.

emailAccountId*string

email account identifier.

to*array<string>

to.

cc?array<string>|

cc.

bcc?array<string>|

bcc.

replyTo?|

reply to.

subject*string

subject.

bodyText?|

body text.

bodyHtml?|

body html.

attachments?array<>|

attachments.

Response Body

`application/json`

curl -X POST "https://example.com/api/email/send" \  -H "Content-Type: application/json" \  -d '{    "emailAccountId": "string",    "to": [      "string"    ],    "subject": "string"  }'

{  "success": true,  "logId": "string",  "provider": "google_workspace",  "providerMessageId": "string",  "providerThreadId": "string"}

{  "_tag": "ApiBadRequestError",  "code": "PRICE_IMPORT_DUPLICATE_SKUS",  "message": "The request payload is invalid.",  "description": "Remove duplicate SKU rows before importing the file.",  "details": null}

{  "_tag": "Unauthorized"}

{  "_tag": "ApiForbiddenError",  "message": "You do not have permission to perform this action."}

{  "_tag": "ApiNotFoundError",  "message": "The requested resource was not found."}

{  "_tag": "ApiConflictError",  "message": "A resource with this handle already exists."}

{  "_tag": "ApiUnprocessableEntityError",  "message": "The order cannot be submitted without items."}

{  "_tag": "ServiceUnavailable"}

{  "_tag": "ApiTimeoutError",  "message": "The upstream operation timed out."}

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`