Create a task

v1.0.0

Creates a new task.

At present, tasks can only be created from plaintext without record reference formatting.

Required scopes: task:read-write, object_configuration:read, record_permission:read, user_management:read.

Input

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "assignees",
        "content",
        "deadline_at",
        "format",
        "is_completed",
        "linked_records"
      ],
      "properties": {
        "assignees": {
          "type": "array",
          "description": "Workspace members assigned to this task.",
          "items": {
            "type": "object"
          }
        },
        "content": {
          "type": "string",
          "description": "The text content of the task, in the format specified by the `format` property. A max length of 2000 characters is enforced."
        },
        "deadline_at": {
          "type": [
            "string",
            "null"
          ],
          "description": "The deadline of the task, in ISO 8601 format."
        },
        "format": {
          "type": "string",
          "description": "The format of the task content to be created. Rich text formatting, links and @references are not supported.",
          "enum": [
            "plaintext"
          ]
        },
        "is_completed": {
          "type": "boolean",
          "description": "Whether the task has been completed."
        },
        "linked_records": {
          "type": "array",
          "description": "Records linked to the task. Records can be linked by domain (for companies), email address (for people), record ID (for all objects) or by a unique matching attribute (for all objects). Creating record links within task content text is not possible via the API at present."
        }
      }
    }
  }
}

Output

{
  "type": "object",
  "description": "Success",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "assignees",
        "completed_at",
        "content_plaintext",
        "created_at",
        "created_by_actor",
        "deadline_at",
        "id",
        "is_completed",
        "linked_records"
      ],
      "properties": {
        "assignees": {
          "type": "array",
          "description": "Workspace members assigned to this task.",
          "items": {
            "type": "object",
            "required": [
              "referenced_actor_type",
              "referenced_actor_id"
            ],
            "properties": {
              "referenced_actor_id": {
                "type": "string",
                "format": "uuid",
                "description": "The ID of the workspace member actor assigned to this task."
              },
              "referenced_actor_type": {
                "type": "string",
                "description": "The type of actor. [Read more information on actor types here](/docs/actors).",
                "enum": [
                  "api-token",
                  "workspace-member",
                  "system",
                  "app"
                ]
              }
            }
          }
        },
        "completed_at": {
          "type": [
            "string",
            "null"
          ],
          "description": "When the task was completed, or null if it has not been completed."
        },
        "content_plaintext": {
          "type": "string",
          "description": "The plaintext representation of the task content. Inline linked records will appear as \"@record name\" and are returned in the `linked_records` property."
        },
        "created_at": {
          "type": "string",
          "description": "When the task was created."
        },
        "created_by_actor": {
          "type": "object",
          "description": "The actor that created this task.",
          "properties": {
            "id": {
              "type": "string",
              "description": "An ID to identify the actor."
            },
            "type": {
              "type": "string",
              "description": "The type of actor. [Read more information on actor types here](/docs/actors).",
              "enum": [
                "api-token",
                "workspace-member",
                "system",
                "app"
              ]
            }
          }
        },
        "deadline_at": {
          "type": [
            "string",
            "null"
          ],
          "description": "The deadline date of the task. Returned as an ISO 8601 timestamp."
        },
        "id": {
          "type": "object",
          "required": [
            "task_id",
            "workspace_id"
          ],
          "properties": {
            "task_id": {
              "type": "string",
              "format": "uuid",
              "description": "The ID of the task."
            },
            "workspace_id": {
              "type": "string",
              "format": "uuid",
              "description": "The ID of the workspace the task belongs to."
            }
          }
        },
        "is_completed": {
          "type": "boolean",
          "description": "Whether the task has been completed."
        },
        "linked_records": {
          "type": "array",
          "description": "Records linked to the task. Creating record links within task content text is not possible via the API at present.",
          "items": {
            "type": "object",
            "required": [
              "target_object_id",
              "target_record_id"
            ],
            "properties": {
              "target_object_id": {
                "type": "string",
                "description": "The ID of the parent object the task refers to. At present, only `people` and `companies` are supported."
              },
              "target_record_id": {
                "type": "string",
                "format": "uuid",
                "description": "The ID of the parent record the task refers to."
              }
            }
          }
        }
      }
    }
  }
}