Schedule Activities API

Audience: Developers and Solution Architects

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

Overview

Use the Schedule Activities 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

Use this endpoint to schedule Activities for a future date and time and manage their lifecycle through the platform. It:

Displays Activities with a due_datetime in the UI as future tasks
May trigger an activity.completed webhook when a scheduled Activity is completed
Maintains a Scheduled status until the Activity is logged, at which point it transitions to Completed
Returns a response structured according to the Activities Data Model schema

Schedule Activity Endpoint

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

post

Create scheduled activity

Authorizations

X-API-KEYstringRequired

X-BUSINESS-IDstringRequired

X-USER-IDstringRequired

Body

activity_object_idstring · uuidOptional

activity_object_namestring · min: 1 · 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

idstring · uuidRequired

notestringRequired

due_datetimestring · date-timeRequired

original_due_datetimestring · date-timeRequired

completed_atstring · date-timeRequired

logged_activity_idstring · uuidRequired

activity_objectstringRequired

employeestringRequired

associated_fieldsstringRequired

notificationsstringRequired

createdstring · date-timeRequired

post/api/activities/scheduled-activity

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

{
  "activity_object_name": "call",
  "employee_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "due_datetime": "2024-01-20T15:00:00Z"
}

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-01T00:00:00.000Z",
  "original_due_datetime": "2026-01-01T00:00:00.000Z",
  "completed_at": "2026-01-01T00:00:00.000Z",
  "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": "name@gmail.com",
    "display_name": "text",
    "account_type": "text"
  },
  "associated_fields": "text",
  "notifications": "text",
  "created": "2026-01-01T00:00:00.000Z",
  "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 Agentic Workflows that depend on Activity timing.

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

PreviousActivities API & Webhooks

NextView Logged Activity Details API

Last updated 22 days ago

Was this helpful?