GET
https://www.app.ocoya.com/api/_public/v1/email/settings
Get email sending readiness
curl --request GET \
  --url https://www.app.ocoya.com/api/_public/v1/email/settings \
  --header 'X-API-Key: <api-key>'
{
  "ready": true,
  "problems": [
    "<string>"
  ],
  "channel": true,
  "from": "<string>",
  "replyTo": "<string>",
  "sharedDomain": true,
  "limits": {
    "contacts": 123,
    "sendsPerMonth": 123,
    "lifetime": true
  },
  "usage": {
    "contacts": 123,
    "sendsThisMonth": 123
  },
  "contactsLeft": 123,
  "sendsLeft": 123,
  "emailsPerCredit": 123,
  "contactsCount": 123,
  "testRecipients": [
    "<string>"
  ]
}

Authorizations

X-API-Keystringheaderrequired

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

Query Parameters

brandIdstringrequired

Ocoya brand ID. Get one from GET /brands.

Example:"cmayvq3hk00017apshay5qezu"

Response

application/json

Success

readyboolean
problemsstring[]
channelboolean

The Email channel is added.

fromstring | null
replyTostring | null
sharedDomainboolean

Sent from Ocoya's shared domain, not the brand's own.

limitsobject
Show child attributesHide child attributes
limits.contactsinteger
limits.sendsPerMonthinteger
limits.lifetimeboolean
usageobject
Show child attributesHide child attributes
usage.contactsinteger
usage.sendsThisMonthinteger
contactsLeftinteger
sendsLeftinteger
emailsPerCreditinteger

Sending costs one credit per this many emails.

contactsCountinteger
testRecipientsstring[]