Scheduling Activities via API

Audience: Technical Builders, Implementors, and Developers

Purpose: Enables programmatic creation, scheduling, and updating of Activities in Kizen with clear, accurate, modern API documentation.

Overview

Use this endpoint to create Activities scheduled for a future date and time. Scheduled Activities allow external systems to manage upcoming actions (e.g. calls, tasks, events) and associate them with other records.

The material on this page builds on information covered on the Activities Core Concepts and Activities Data Model.

Why Use this API?

You can use the Scheduling Activities API when you need to:

• Sync reminders, tasks, or appointments from other platforms into Kizen

• Assign tasks to team members

• Create multi-step sequences (e.g., onboarding, sales cadences)

• Sync reminders or appointments from other platforms into Kizen

• Schedule upcoming calls, meetings, or check-ins tied to specific records

Warning: The API shown below can also log Activities, but logging through the use of this API is discouraged because partial or incorrect payloads can overwrite existing Activity data.

Scheduling Activity API Behavior

• Activities scheduled with due_datetime appear in the UI as future tasks

• If a scheduled Activity is completed, a webhook (activity.completed) may fire

• Scheduled Activities remain in a Scheduled status until the Activity is logged, at which point it is marked as Completed

• The structure of the response object matches the schema defined in Activities Data Model

---

Schedule Activity Endpoint

Want to try the API out? Visit our Swagger docs.

post

Create scheduled activity

Authorizations

businessId & userId & apiKey

X-BUSINESS-IDstringRequired

X-USER-IDstringRequired

X-API-KEYstringRequired

Body

application/json

activity_object_idstring · uuidOptional

activity_object_namestring | nullableOptional

due_datetimestring · date-timeOptional

original_due_datetimestring · date-timeOptional

employee_idstring · uuid | nullableOptional

role_idstring · uuid | nullableOptional

notestringOptional

mentionsstring · uuid[]Optional

notify_mentionedbooleanOptionalDefault: false

Responses

201Success

application/json

post

/api/activities/scheduled-activity

HTTPcURLJavaScriptPython

POST /api/activities/scheduled-activity HTTP/1.1
Host: 
X-BUSINESS-ID: YOUR_API_KEY
X-USER-ID: YOUR_API_KEY
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 620

{
  "activity_object_id": "123e4567-e89b-12d3-a456-426614174000",
  "activity_object_name": "text",
  "due_datetime": "2026-01-17T14:10:24.104Z",
  "original_due_datetime": "2026-01-17T14:10:24.104Z",
  "employee_id": "123e4567-e89b-12d3-a456-426614174000",
  "role_id": "123e4567-e89b-12d3-a456-426614174000",
  "note": "text",
  "mentions": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "notifications": [
    {
      "type": "email",
      "time_amount": 1,
      "time_unit": "minute"
    }
  ],
  "associated_entities": [
    {
      "custom_object": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "entity": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      }
    }
  ],
  "notify_mentioned": false
}

201Success

{
  "associated_entities": [
    {
      "custom_object": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "object_name": "text"
      },
      "entity": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "email": "text",
        "display_name": "text"
      }
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "note": "text",
  "due_datetime": "2026-01-17T14:10:24.104Z",
  "original_due_datetime": "2026-01-17T14:10:24.104Z",
  "completed_at": "2026-01-17T14:10:24.104Z",
  "logged_activity_id": "123e4567-e89b-12d3-a456-426614174000",
  "activity_object": "text",
  "employee": "text",
  "role": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "default_for_new_users": true
  },
  "mentions": {
    "picture_url": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "first_name": "text",
    "last_name": "text",
    "email": "[email protected]",
    "display_name": "text"
  },
  "associated_fields": "text",
  "notifications": "text",
  "created": "2026-01-17T14:10:24.104Z",
  "access": {
    "view": true,
    "edit": true,
    "remove": true
  }
}

Scheduled Activity Schemas

---

What's Next?

After scheduling Activities via the API, you can:

• Create scheduled Activities as business needs change.

• Understand when a scheduled Activity becomes a logged Activity.

• Use Scheduled Activities alongside automations or workflows that depend on Activity timing.

For more information on Activities, check out the following topics:

Related Topics

• Activities

• Activities Core Concepts

• Activities Data Model

• Activity Permissions

• Advanced Activity Rules

• Activities API & Webhooks