Schedule a campaign | Keila Full API Octri Preview

1 parameter · 1 body field

idstringrequired

The campaign identifier.

Scheduling details in a data object.

dataobjectoptional

Scheduling parameters, including the optional `scheduled_for` date and time.

1 status code

200Returns the campaign object, including its updated scheduling details.

dataobjectoptional

Error handling

The id path parameter identifies the campaign to schedule. When provided, scheduled_for must use a date-time format.

<?php

require __DIR__ . '/vendor/autoload.php';

use keila_full_api_octri_preview_sdk\ClientConfig;
use keila_full_api_octri_preview_sdk\SdkConfig;
use keila_full_api_octri_preview_sdk\ClientAuthConfig;
use keila_full_api_octri_preview_sdk\KeilaAPIUnofficialOctriFullPreview;

$config = new ClientConfig();
$config->baseUrl = "https://app.keila.io";
$auth = new ClientAuthConfig();
$auth->authorization = getenv('API_TOKEN') ?: throw new RuntimeException('API_TOKEN is required');
$config->auth = $auth;
$client = new KeilaAPIUnofficialOctriFullPreview($config);

$result = $client->campaign->keilaWebApiControllerSchedule(id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21");

{
  "data": {
    "data": {
      "books": [
        {
          "title": "Space Book",
          "url": "books.books/spacebook"
        },
        {
          "title": "Earth Book",
          "url": "books.books/earthbook"
        }
      ]
    },
    "html_body": "<!doctype html>\n<html>\n  <body>\n    <h1>Hello {{ contact.first_name }}!</h1>\n  </body>\n</html>\n",
    "html_content": {
      "main": "<p>Hi {{ contact.first_name }}!</p>"
    },
    "id": "mc_12345",
    "inserted_at": "2026-10-20T11:25:56.245665Z",
    "json_body": {
      "blocks": [
        {
          "data": {
            "text": "Hello, I am a block campaign!"
          },
          "id": "ff0011",
          "type": "paragraph"
        }
      ]
    },
    "mjml_body": "<mjml>\n  <mj-body>\n    <mj-section>\n      <mj-column>\n        <mj-text>Hello I’m an MJML campaign!</mj-text>\n      </mj-column>\n    </mj-section>\n  </mj-body>\n</mjml>\n",
    "mjml_content": {
      "main": "<mj-text>Hi {{ contact.first_name }}!</mj-text>"
    },
    "preview_text": "Hello, I am a preview campaign!",
    "scheduled_for": "2026-10-20T11:25:56.245661Z",
    "segment_id": "sgm_12345",
    "sender_id": "ms_12345",
    "sent_at": "2026-10-20T11:25:56.245637Z",
    "settings": {
      "do_not_track": true,
      "type": "markdown"
    },
    "subject": "🚀 Our Space Book is Now Available!",
    "template_id": "550e8400-e29b-41d4-a716-446655440000",
    "text_body": "Hey {{ contact.first_name }}, are you excited for our Space Book?\n\n[…]\n\n## All Books by Acme Space Corp:\n{% for book in campaign.data.books %}\n  - {{ book.title }}: [More info]({{ book.url }})\n{% endfor %}\n",
    "text_content": {
      "main": "Hi {{ contact.first_name }}!"
    },
    "updated_at": "2026-10-20T11:25:56.245669Z"
  }
}

Request

Response

Errors