POST
https://www.app.ocoya.com/api/_public/v1/campaigns/{campaignId}/schedule
Schedule an email campaign
curl --request POST \
  --url https://www.app.ocoya.com/api/_public/v1/campaigns/{campaignId}/schedule \
  --header 'X-API-Key: <api-key>'
{
  "campaignId": "<string>",
  "status": "<string>",
  "scheduled": 123,
  "recipients": 123
}

Authorizations

X-API-Keystringheaderrequired

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

Path Parameters

campaignIdstringrequired

Email campaign ID, from POST /campaigns with type: "email".

Example:"cmayxcmpn00087aps2m7hjs9z"

Query Parameters

brandIdstringrequired

Ocoya brand ID. Get one from GET /brands.

Example:"cmayvq3hk00017apshay5qezu"

Response

application/json

Scheduled

campaignIdstring
statusstring
scheduledinteger
recipientsinteger