Events (Calendar)

This is the User's calendar for managing their schedule and important dates. Companies can also add events to their members' calendars based on country or individually via the API, making it easy to communicate trainings, promotions, and company-wide announcements.

Rules

Events are created by the Company and pushed to Users based on their country
Events send push notifications when starting soon (within 1 hour of start time)
Events have status indicators: STARTING SOON, IN PROGRESS, or CONCLUDED
Events can have multiple images and a venue/location
Events are automatically removed from active view after their end time

JSON Structure

{
  "id": 12345,
  "company_id": 67890,
  "user_id": null,
  "title": "Summer Product Launch",
  "description": "Join us for the unveiling of our new summer collection!",
  "url": "https://example.com/events/summer-launch",
  "venue": "Virtual Event - Zoom",
  "color": "#FF5733",
  "start": "2025-06-15T14:00:00Z",
  "end": "2025-06-15T16:00:00Z",
  "time_zone": "America/New_York",
  "canonical_time_zone": "America/New_York",
  "active": true,
  "status": "STARTING SOON",
  "image_url": "https://example.com/images/summer-launch.jpg",
  "images": [
    {
      "id": 111,
      "position": 1,
      "mini": "https://example.com/images/summer-launch-mini.jpg",
      "detail": "https://example.com/images/summer-launch-detail.jpg",
      "full": "https://example.com/images/summer-launch.jpg"
    }
  ],
  "countries": ["US", "CA", "MX"],
  "notification_sent_at": null
}

API Endpoints

Company Scoped

Verb	Endpoint	Description
GET	`/api/company/crm/v202506/events`	List all events
GET	`/api/company/crm/v202506/events/:id`	Get a specific event
POST	`/api/company/crm/v202506/events`	Create a new event
PATCH	`/api/company/crm/v202506/events/:id`	Update an event
DELETE	`/api/company/crm/v202506/events/:id`	Delete an event

User Scoped

Verb	Endpoint	Description
GET	`/api/user/crm/v202506/events`	List user's events
GET	`/api/user/crm/v202506/events/:id`	Get a specific event
POST	`/api/user/crm/v202506/events`	Create a new event
PATCH	`/api/user/crm/v202506/events/:id`	Update an event
DELETE	`/api/user/crm/v202506/events/:id`	Delete an event

Next Steps

Review the Core Elements Overview for API access patterns
See Use Cases for examples of Events in workflows
Explore the User API Reference for detailed endpoint documentation