Create a new task

Request Information

URI Parameters :

None.

Body Parameters :

task
NameDescriptionTypeAdditional information
id

Primary Key

 globally unique identifier
task_type_id

Foreign key of task type for this task.If not filled,one default will be used

 globally unique identifier
task_status_id

Foreign key of task status for this task.When adding a task, the default task_status will be used

 globally unique identifier
task_priority_id

Foreign key of task priority for this task.If not filled,one default will be used

 globally unique identifier
company_id

The company linked to this task. Autofilled based on credentials

 globally unique identifier
contact_id

The contact that created this task. Filled automatically when adding a task

 globally unique identifier
to_db_table_id

Foreign key to the table that is linked to this task (Example:project or jobs) using Guid

 globally unique identifier
to_db_table_name

Foreign key to the table that is linked to this task (Example:project or jobs) using table name

 string
to_id_in_table

Foreign key of the object that is linked to this task using Odyssee Guid Primary Key (Exemple:project.id or jobs.id)

 globally unique identifier
subject

Subject of the Task

 string

Required

Max length: 150
remark

Remark of the Task (long text area field)

 string
customer_reference

Reference of this task for the customer

 string

Max length: 50
date_create

Creation date+time. Automaticaly filled when adding if no value specified

 date
date_start

Starting date of the task (date_start in the future are not shown on the UI)

 date
due_date

Deadline to close the task

 date
date_closed

Date+Time when the task goes into archive (=completed)

 date
archived

Indicate that the task is now closed (has been updated to a task status 'Completed').Automatically filled when adding/updating a task based on the task_type

 boolean
date_assigned

Date+Time when the task has been assigned to a specific user

 date
date_suggested_by_company

Date+Time suggested by the company to start working on this task

 date
id2

Internal ID (numeric). Will be used on the UI to identify easily the task

 integer
reference_back_office

The Id/Ref of the back office for this task

 string

Max length: 50
created_by_servicedesk_api

ReadOnly,Specify that the task has been created by ServiceDesk

 boolean
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

 date

Request Formats :

application/json, text/json

Sample: 
{
  "id": "3970f5af-af17-4420-b038-a1efdc261244",
  "task_type_id": "0d617cf0-d523-44dc-aadd-19baf06cf913",
  "task_status_id": "d04abcdd-1a87-4d49-af1d-33ef6195ebd3",
  "task_priority_id": "d69a8b21-9de2-4ec2-9a48-f91277b2ba4c",
  "company_id": "586e803d-0d26-4307-9727-b1f8abd97122",
  "contact_id": "4c11664c-c6df-4e35-beb3-0290ddc7b6d7",
  "to_db_table_id": "4ea0c198-0550-444a-b8a6-2949d3c2938b",
  "to_db_table_name": "sample string 8",
  "to_id_in_table": "df39fee8-721c-4c83-9fe2-6403dce36537",
  "subject": "sample string 10",
  "remark": "sample string 11",
  "customer_reference": "sample string 12",
  "date_create": "2026-06-24T03:56:41.4578039+00:00",
  "date_start": "2026-06-24T03:56:41.4578039+00:00",
  "due_date": "2026-06-24T03:56:41.4578039+00:00",
  "date_closed": "2026-06-24T03:56:41.4578039+00:00",
  "archived": true,
  "date_assigned": "2026-06-24T03:56:41.4578039+00:00",
  "date_suggested_by_company": "2026-06-24T03:56:41.4578039+00:00",
  "id2": 20,
  "reference_back_office": "sample string 21",
  "created_by_servicedesk_api": true,
  "modified_dateutc": "2026-06-24T03:56:41.4578039+00:00"
}

application/xml, text/xml

Sample: 
<task xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <archived>true</archived>
  <company_id>586e803d-0d26-4307-9727-b1f8abd97122</company_id>
  <contact_id>4c11664c-c6df-4e35-beb3-0290ddc7b6d7</contact_id>
  <created_by_servicedesk_api>true</created_by_servicedesk_api>
  <customer_reference>sample string 12</customer_reference>
  <date_assigned>2026-06-24T03:56:41.457Z</date_assigned>
  <date_closed>2026-06-24T03:56:41.457Z</date_closed>
  <date_create>2026-06-24T03:56:41.457Z</date_create>
  <date_start>2026-06-24T03:56:41.457Z</date_start>
  <date_suggested_by_company>2026-06-24T03:56:41.457Z</date_suggested_by_company>
  <due_date>2026-06-24T03:56:41.457Z</due_date>
  <id>3970f5af-af17-4420-b038-a1efdc261244</id>
  <id2>20</id2>
  <modified_dateutc>2026-06-24T03:56:41.457Z</modified_dateutc>
  <reference_back_office>sample string 21</reference_back_office>
  <remark>sample string 11</remark>
  <subject>sample string 10</subject>
  <task_priority_id>d69a8b21-9de2-4ec2-9a48-f91277b2ba4c</task_priority_id>
  <task_status_id>d04abcdd-1a87-4d49-af1d-33ef6195ebd3</task_status_id>
  <task_type_id>0d617cf0-d523-44dc-aadd-19baf06cf913</task_type_id>
  <to_db_table_id>4ea0c198-0550-444a-b8a6-2949d3c2938b</to_db_table_id>
  <to_db_table_name>sample string 8</to_db_table_name>
  <to_id_in_table>df39fee8-721c-4c83-9fe2-6403dce36537</to_id_in_table>
</task>

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.