---
title: "Create Calendar"
method: POST
path: "/calendar"
tags: ["Events/Tasks"]
---

# Create Calendar

`POST /calendar`

## Request

- Base URL: `https://api.forcemanager.com/api/v4`
- URL: `https://api.forcemanager.com/api/v4/calendar`
- Auth: API key in header `X-Session-Key`

This endpoint allows you to create a Event/Task based on JSON input.

You will only be able to create an Event after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).

**HEADERS**

| **Parameter** | **Value** | **Description** |
| --- | --- | --- |
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | \*/\* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |

**REQUEST BODY**

| **Attribute** | **Type** | **Description** |
| --- | --- | --- |
| accountId | Integer | Account to which the Event/Task is linked |
| allDay | Boolean | If true, the Event/Task takes all day, it does not have a start and end time specified |
| branchId | Integer | Branch the Event/Task is assigned to |
| city | String | City name |
| comment | String | Comment added to the Event/Task |
| contactId | Integer | Contact to which an Event/Task is linked |
| endDate | String | End Date and time of the Event/Task |
| extId | String | External ID of the Event/Task from a third party system (ERP, CRM, Accounting System) |
| id | Integer | The Event/Task's unique identifier |
| opportunityId | Integer | Opportunity to which the Event/Task is linked |
| permissionLevel | String | Defines the visibility of the Event/Task. Set from 1 to 5 being 5 the highest level of permission |
| readOnly | Boolean | If true, the Event/Task can not be modified or deleted |
| reminder | Integer | Time before the Event/Task when you want to be reminded of it: -2: not used, 1: Remind at the start time, 5: 5 minutes before to start, 15: 15 minutes before to start, 30: 30 minutes before to start, 1440: 1 hour before to start, 3600: 1 days before to start, 10080: 1 week before to start |
| salesRepId | Integer | User responsible for this Event/Task |
| sendNotification | Boolean | If true, an invitation email will be sent to the Contacts of the Event/Task |
| startDate | String | Start Date of the Event/Task |
| startHour | String | Start hour of the Event/Task |
| subject | String | Description or name of the Event/Task |
| task | Boolean | If true, the entity is a Task. Then `endDate` and `endHour` is not needed |
| typeId | Integer | Type of the Event/Task. e.g. meeting, visit, etc. |
| completed | Boolean | If true, the Task is considered completed |

**RESPONSE**

Returns a JSON with information about the Event/Task just created.

| **Attribute** | **Type** | **Description** |
| --- | --- | --- |
| id | Integer | Id assigned to the new Event/Task |
| Message | String | Shows the operation status |

**RESPONSE CODES**

| **Status** | **Description** |
| --- | --- |
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |

## Headers

- `Accept` string

## Request body

- object
  - `accountId` integer
  - `allDay` boolean
  - `branchId` integer
  - `comment` string
  - `contactId` integer
  - `endDate` string
  - `salesRepId` integer
  - `sendNotification` boolean
  - `startDate` string
  - `startHour` string
  - `subject` string
  - `task` boolean
  - `typeId` string

## Response `200`

Create calendar

---

[API](https://skmtc.dev/forcemanager/apis/sage-sales-management-public-api-documentation-for-developer.md) · [All operations](https://skmtc.dev/forcemanager/apis/sage-sales-management-public-api-documentation-for-developer/llms.txt) · [OpenAPI document](https://skmtc.dev/forcemanager/apis/sage-sales-management-public-api-documentation-for-developer/revisions/87db17204e2f?raw)