Merge · Schema

TaskRequest

# The Task Object ### Description The `Task` object is used to represent a task, such as a to-do item. ### Usage Example TODO

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name Type Description
subject stringnull The task's subject.
content stringnull The task's content.
owner stringnull The task's owner.
account stringnull The task's account.
opportunity stringnull The task's opportunity.
contact stringnull The task's contact.
completed_date stringnull When the task is completed.
due_date stringnull When the task is due.
status object The task's status.
task_url stringnull The task's URL in the remote system.
integration_params objectnull
linked_account_params objectnull
remote_fields array
View JSON Schema on GitHub

JSON Schema

merge-taskrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TaskRequest",
  "title": "TaskRequest",
  "type": "object",
  "properties": {
    "subject": {
      "type": [
        "string",
        "null"
      ],
      "description": "The task's subject."
    },
    "content": {
      "type": [
        "string",
        "null"
      ],
      "description": "The task's content."
    },
    "owner": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The task's owner."
    },
    "account": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The task's account."
    },
    "opportunity": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The task's opportunity."
    },
    "contact": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The task's contact."
    },
    "completed_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the task is completed."
    },
    "due_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the task is due."
    },
    "status": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/TaskStatusEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The task's status."
    },
    "task_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "The task's URL in the remote system."
    },
    "integration_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "linked_account_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "remote_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RemoteFieldRequest"
      }
    }
  },
  "description": "# The Task Object\n### Description\nThe `Task` object is used to represent a task, such as a to-do item.\n### Usage Example\nTODO"
}