Send a test email - Ocoya API Docs

Sends the email as saved to people in the brand only (testRecipients from GET /email/settings). Free, and never sent to contacts.

POST

https://www.app.ocoya.com/api/_public/v1/email/{emailId}/test

Send a test email

cURL

curl --request POST \
  --url https://www.app.ocoya.com/api/_public/v1/email/{emailId}/test \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "to": [
    "you@example.com"
  ]
}
'

{
  "sent": 123,
  "to": [
    "<string>"
  ]
}

Authorizations

X-API-Keystringheaderrequired

Your API key. Create one in Ocoya. Authorization: Bearer <key> works too.

Path Parameters

emailIdstringrequired

Ocoya email ID, from GET /email.

Example:"cmwdkjtfh005gy0k4ggzzg1bs"

Body

application/json

tostring[]required

Addresses of people in the brand.

Example:

[
  "you@example.com"
]

Response

200application/json

Sent

sentinteger

tostring[]

Send a test email

cURL

curl --request POST \
  --url https://www.app.ocoya.com/api/_public/v1/email/{emailId}/test \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "to": [
    "you@example.com"
  ]
}
'

{
  "sent": 123,
  "to": [
    "<string>"
  ]
}

Was this page helpful?