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

# Create a task

> Creates an org-level task. `related_records` cannot be stored on create — the model saves the task first, then applies them in a second update.



## OpenAPI

````yaml /api-reference/specs/tasks.json post /api/tasks
openapi: 3.1.0
info:
  title: ConveYour API — Tasks
  description: >-
    Actionable items. Two separate resources: org-level tasks assigned to users
    or teams, and contact-level tasks attached to an individual contact.
  version: 1.0.0
servers:
  - url: https://{subdomain}.conveyour.com
    description: Your organization's ConveYour instance
    variables:
      subdomain:
        default: acme
        description: >-
          Your organization's slug — the subdomain you sign in on. Replace
          `acme` with yours: if you sign in at `bigco.conveyour.com`, enter
          `bigco`.
security:
  - conveyourToken: []
paths:
  /api/tasks:
    post:
      tags:
        - Tasks
      summary: Create a task
      description: >-
        Creates an org-level task. `related_records` cannot be stored on create
        — the model saves the task first, then applies them in a second update.
      operationId: createTask
      parameters:
        - $ref: '#/components/parameters/teams'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
              properties:
                name:
                  type: string
                  description: Task name. Required.
                status:
                  type: string
                  enum:
                    - not_started
                    - planning
                    - todo
                    - doing
                    - reviewing
                    - ready
                    - done
                  description: Defaults to not_started.
                body:
                  type: string
                  description: Task body (HTML).
                assigned_to:
                  type: array
                  items:
                    type: integer
                  description: User IDs to assign.
                related_records:
                  type: array
                  items:
                    type: string
                  description: Related record keys.
                resources:
                  type: array
                  items:
                    type: object
                  description: Other resources.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/Task'
        '403':
          description: >-
            Forbidden — the token is missing, expired, or not permitted for this
            HTTP method. **These endpoints enforce no named permission**, so a
            403 here never carries a `permission` field.
components:
  parameters:
    teams:
      name: teams[]
      in: query
      description: >-
        Team scope for the request, as one or more team ObjectIds. The brackets
        are required: PHP keeps only the last value for a repeated plain key, so
        `teams=A&teams=B` silently resolves to B alone. On requests with a JSON
        body you may send `teams` (no brackets) in the body instead.


        **Values that are not valid ObjectIds are silently ignored** — a
        mistyped team ID behaves as if no team was sent. See the [teams section
        of the API conventions guide](/guides/api-conventions#team-scoping).
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
      example:
        - 64a1b2c3d4e5f6a7b8c9d0ff
  schemas:
    Envelope:
      type: object
      description: The common response envelope shared by all ConveYour endpoints.
      properties:
        status:
          type: string
          enum:
            - ok
            - failed
          description: '`ok` on success, `failed` on error.'
        message:
          type: string
          description: Human-readable description of the result.
        data:
          description: >-
            The response payload — an object or an array depending on the
            endpoint.
    Task:
      type: object
      description: An org-level task.
      properties:
        id:
          type: string
          description: Task ID.
        org_id:
          type: integer
          description: Owning organization.
        name:
          type: string
          description: Task name. Required.
        status:
          type: string
          enum:
            - not_started
            - planning
            - todo
            - doing
            - reviewing
            - ready
            - done
          default: not_started
          description: Workflow status. Defaults to not_started.
        body:
          type: string
          description: Task body. Stored as HTML.
        assigned_to:
          type: array
          items:
            type: integer
          description: User IDs assigned to the task.
        related_records:
          type: array
          items:
            type: string
          description: >-
            Related record keys in the form `ClassName@ObjectId`, e.g.
            `Trigger@5aa705061c337a665c8b457c`. Note these cannot be saved on
            create; send them in a follow-up update.
        resources:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                  - url
                description: Resource type.
              value:
                type: string
                description: Resource value.
          description: Other resources attached to the task.
        slug:
          type: string
          description: Slug. Hidden in the UI; unique per team.
        meta:
          type: object
          description: Arbitrary metadata. Hidden in the UI.
        created_at:
          type: string
          description: Creation timestamp.
        updated_at:
          type: string
          description: Last update timestamp.
      required:
        - name
  securitySchemes:
    conveyourToken:
      type: apiKey
      in: header
      name: x-conveyour-token
      description: >-
        Your API key token. Contacts endpoints require a **Server-only — Full
        API** key — see [Authentication](/quickstart).

````

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