> ## Documentation Index
> Fetch the complete documentation index at: https://docs.parley.so/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a task

> Create a task, optionally about one project, account, or contact, with a status (todo unless given), assignee, due date, and description. Pass reminder to have Parley remind the caller about it.



## OpenAPI

````yaml https://api.parley.so/openapi.json post /tasks
openapi: 3.1.1
info:
  title: Parley API
  version: 1.0.0
  description: >-
    Manage Parley's projects (matters or cases), accounts (client
    organizations), contacts (people), tasks, custom fields, notes, files,
    activity, automations, and skills. Records refer to each other as { type,
    id, name } references; writes take IDs. Errors are { error: { code, message,
    details } }, where code names what went wrong and each operation lists the
    codes it can return. In a query string, write a timestamp's offset as Z or
    %2B, because a raw + arrives as a space. The MCP server at /mcp offers the
    same data as a smaller set of tools.
servers:
  - url: https://api.parley.so/v1
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: >-
      A project is a matter or case: it groups the files, notes, activity, and
      tasks for one engagement, and links to the accounts and contacts it
      involves.
  - name: Accounts
    description: >-
      An account is a client organization. Contacts belong to it, and projects
      link to it.
  - name: Contacts
    description: >-
      A contact is a person, optionally belonging to one account and linked to
      projects.
  - name: Tasks
    description: >-
      A task is a to-do with a status, assignee, and due date, optionally about
      one project, account, or contact.
  - name: Fields
    description: >-
      Custom fields defined for projects, accounts, contacts, or tasks. Records
      carry their values in fields, keyed by field name.
  - name: Notes
    description: >-
      Markdown notes on a project, account, or contact. Updates take the version
      you last read, so concurrent edits fail with 409 VERSION_CONFLICT instead
      of overwriting.
  - name: Files
    description: >-
      Files and folders of a project, account, contact, or intake, or the
      organization's Library. Add a file by creating an upload, PUTting its
      bytes, and adding the upload to a location.
  - name: Activity
    description: >-
      What happened across the organization or on one record: changes, links,
      notes, files, USCIS case updates, and synced emails and meetings. Each
      item's kind says which details it carries.
  - name: Sessions
    description: >-
      Conversations with Parley's assistant, from the web app, Word, Outlook,
      automation runs, and the API. Start one with a message, follow up or steer
      it while it works, and read its replies.
  - name: Automations
    description: >-
      Instructions Parley's assistant carries out on a schedule, as the person
      who created them, with nobody present.
  - name: Skills
    description: >-
      Reusable playbooks for Parley's assistant: a SKILL.md plus optional
      bundled documents, addressed by slug.
  - name: Users
    description: The people in your organization, and the caller.
paths:
  /tasks:
    post:
      tags:
        - Tasks
      summary: Create a task
      description: >-
        Create a task, optionally about one project, account, or contact, with a
        status (todo unless given), assignee, due date, and description. Pass
        reminder to have Parley remind the caller about it.
      operationId: createTask
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  minLength: 1
                  maxLength: 500
                  description: Task title.
                status:
                  enum:
                    - todo
                    - in_progress
                    - done
                    - cancelled
                  type: string
                  description: Defaults to todo.
                assigneeId:
                  type: string
                  minLength: 1
                  description: >-
                    The ID of an active user in the organization to assign it
                    to.
                dueDate:
                  type: string
                  format: date
                  description: The day the task is due, as YYYY-MM-DD.
                description:
                  type: string
                  minLength: 1
                  maxLength: 2000
                  description: Details, up to 2,000 characters.
                linkedRecord:
                  type: object
                  properties:
                    type:
                      enum:
                        - project
                        - account
                        - contact
                      type: string
                      description: 'The kind of record: project, account, or contact.'
                    id:
                      type: string
                      minLength: 1
                      description: The record's ID.
                  required:
                    - type
                    - id
                  additionalProperties: false
                  description: >-
                    The project, account, or contact the task is about, as {
                    type, id }. A project must be one you can edit.
                reminder:
                  type: object
                  properties:
                    remindAt:
                      type: string
                      format: date-time
                      description: >-
                        When Parley should remind you, through your notification
                        settings. An ISO 8601 date-time in the future.
                  required:
                    - remindAt
                  additionalProperties: false
                  description: Your reminder for the task, as { remindAt }.
                fields:
                  type: object
                  propertyNames:
                    type: string
                    minLength: 1
                  additionalProperties:
                    anyOf:
                      - type: string
                      - type: number
                      - type: boolean
                      - type: array
                        items:
                          type: string
                      - type: object
                        properties:
                          streetAddress:
                            anyOf:
                              - type: string
                              - type: 'null'
                          cityTown:
                            anyOf:
                              - type: string
                              - type: 'null'
                          state:
                            anyOf:
                              - type: string
                              - type: 'null'
                          country:
                            anyOf:
                              - type: string
                              - type: 'null'
                        additionalProperties: false
                      - type: 'null'
                  description: >-
                    Custom field values to set on the task, keyed by field name
                    or ID. A value replaces the current one, null clears it, and
                    fields you don't mention are left alone. Each value must
                    match its field's type: a string for text, long_text, email,
                    url, single_select (one of the field's options), and user
                    (the id of an active user in the organization); a number;
                    true or false; an ISO 8601 date-time or YYYY-MM-DD date; a
                    list of strings for collection ([] clears it); or {
                    streetAddress, cityTown, state, country } for address. At
                    most 50 fields. Status, assignee, due date, and description
                    are properties of the task, not fields.
              required:
                - title
              additionalProperties: false
      responses:
        '201':
          description: Created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
          headers:
            Location:
              description: The URL of the created resource.
              schema:
                type: string
        '400':
          description: >-
            The request was invalid. VALIDATION_FAILED, INVALID_REFERENCE,
            INVALID_FIELD_VALUES.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationFailedError'
                  - $ref: '#/components/schemas/InvalidReferenceError'
                  - $ref: '#/components/schemas/InvalidFieldValuesError'
        '401':
          description: Missing or invalid credentials. UNAUTHORIZED.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '403':
          description: You don't have permission. FORBIDDEN.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '429':
          description: Too many requests, or a usage limit was reached. TOO_MANY_REQUESTS.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsError'
components:
  schemas:
    Task:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          description: The task ID.
        title:
          type: string
          minLength: 1
          maxLength: 500
          description: Task title.
        status:
          anyOf:
            - enum:
                - todo
                - in_progress
                - done
                - cancelled
              type: string
              description: >-
                Where the task stands: todo, in_progress, done, or cancelled.
                done and cancelled close it.
            - type: 'null'
          description: >-
            Where the task stands: todo, in_progress, done, or cancelled, or
            null when it has no status. done and cancelled close it.
        assignee:
          anyOf:
            - $ref: '#/components/schemas/UserRef'
            - type: 'null'
          description: The person the task is assigned to, or null.
        dueDate:
          anyOf:
            - type: string
              format: date
              description: The day the task is due, as YYYY-MM-DD.
            - type: 'null'
          description: The day the task is due, as YYYY-MM-DD, or null.
        description:
          anyOf:
            - type: string
            - type: 'null'
          description: Details, or null.
        linkedRecord:
          anyOf:
            - $ref: '#/components/schemas/RecordRef'
            - type: 'null'
          description: The project, account, or contact the task is about, or null.
        reminder:
          anyOf:
            - type: object
              properties:
                remindAt:
                  type: string
                  format: date-time
                  description: When Parley reminds you, through your notification settings.
                sentAt:
                  anyOf:
                    - type: string
                      format: date-time
                    - type: 'null'
                  description: When the reminder was sent, or null until then.
              required:
                - remindAt
                - sentAt
            - type: 'null'
          description: >-
            Your reminder for the task, or null. Reminders are personal: each
            person sees only their own.
        createdAt:
          type: string
          format: date-time
          description: When the task was created.
        updatedAt:
          type: string
          format: date-time
          description: >-
            When the task was last renamed or linked to a different record.
            Changes to its status, assignee, due date, description, field
            values, and reminders do not change it.
        fields:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            anyOf:
              - type: string
              - type: number
              - type: boolean
              - type: array
                items:
                  type: string
              - type: object
                properties:
                  streetAddress:
                    anyOf:
                      - type: string
                      - type: 'null'
                  cityTown:
                    anyOf:
                      - type: string
                      - type: 'null'
                  state:
                    anyOf:
                      - type: string
                      - type: 'null'
                  country:
                    anyOf:
                      - type: string
                      - type: 'null'
                required:
                  - streetAddress
                  - cityTown
                  - state
                  - country
                description: A postal address. Each part is a string or null.
              - type: 'null'
          description: >-
            Custom field values, keyed by field name, with a key for every field
            defined for tasks (null when unset). The value's shape follows the
            field's type. Status, assignee, due date, and description are
            properties of the task, not fields.
      required:
        - id
        - title
        - status
        - assignee
        - dueDate
        - description
        - linkedRecord
        - reminder
        - createdAt
        - updatedAt
        - fields
    ValidationFailedError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              const: VALIDATION_FAILED
            message:
              type: string
              examples:
                - The request is invalid.
            details:
              type: object
              properties:
                issues:
                  type: array
                  items:
                    type: object
                    properties:
                      path:
                        type: string
                        description: >-
                          Where the problem is, as a dotted path into the input
                          such as accountIds.add.0 or reminder.remindAt. Empty
                          for the input as a whole.
                      message:
                        type: string
                        description: What is wrong with the value.
                    required:
                      - path
                      - message
                  description: Each problem with the input.
              required:
                - issues
          required:
            - code
            - message
            - details
      required:
        - error
    InvalidReferenceError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              const: INVALID_REFERENCE
            message:
              type: string
              examples:
                - >-
                  The request refers to a record or user that doesn't exist or
                  that you can't use.
            details:
              type: object
              properties:
                field:
                  type: string
                  description: The input that holds the reference, such as accountIds.
                ids:
                  type: array
                  items:
                    type: string
                  description: The IDs that could not be used.
              required:
                - field
                - ids
          required:
            - code
            - message
            - details
      required:
        - error
    InvalidFieldValuesError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              const: INVALID_FIELD_VALUES
            message:
              type: string
              examples:
                - Some custom field values were not accepted.
            details:
              type: object
              properties:
                unknownFields:
                  type: array
                  items:
                    type: string
                  description: Keys that are not the name or ID of a field.
                readOnlyFields:
                  type: array
                  items:
                    type: string
                  description: Fields Parley maintains, which cannot be set.
                duplicateFields:
                  type: array
                  items:
                    type: string
                  description: Keys that set a field another key already sets.
                invalidValues:
                  type: array
                  items:
                    type: object
                    properties:
                      field:
                        type: string
                        description: The name or ID the value was given under.
                      expected:
                        type: string
                        description: What the field accepts.
                    required:
                      - field
                      - expected
              required:
                - unknownFields
                - readOnlyFields
                - duplicateFields
                - invalidValues
          required:
            - code
            - message
            - details
      required:
        - error
    UnauthorizedError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              const: UNAUTHORIZED
            message:
              type: string
              examples:
                - Missing or invalid credentials.
          required:
            - code
            - message
      required:
        - error
    ForbiddenError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              const: FORBIDDEN
            message:
              type: string
              examples:
                - You don't have permission to do this.
          required:
            - code
            - message
      required:
        - error
    TooManyRequestsError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              const: TOO_MANY_REQUESTS
            message:
              type: string
              examples:
                - Too many requests.
          required:
            - code
            - message
      required:
        - error
    UserRef:
      type: object
      properties:
        id:
          type: string
          description: The user's ID.
        name:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The user's full name, or null when it is unknown, as for someone who
            has left the organization.
        email:
          anyOf:
            - type: string
            - type: 'null'
          description: The user's email address, or null when it is unknown.
      required:
        - id
        - name
        - email
      description: A reference to a person in the organization.
    RecordRef:
      type: object
      properties:
        type:
          enum:
            - project
            - account
            - contact
          type: string
          description: 'The kind of record: project, account, or contact.'
        id:
          type: string
          description: Its ID.
        name:
          type: string
          description: >-
            The record's name. A contact's is its first and last name, or an
            email address when it has no name.
      required:
        - type
        - id
        - name
      description: A reference to a project, account, or contact.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A Parley API key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.