POST /api/v1/task
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string
application/json

Body

  • name string Required

    The name of the task

  • description string

    The description of the task

  • priority string

    The task's priority. Available options: low, medium, high and highest

    Value Description
    low Low
    medium Medium
    high High
    highest Highest

    Values are low, medium, high, or highest.

  • due_at string(date)

    The task due date

  • taskable_type string Required

    The taskable type. Available Options: client, case, plan

    Values are client, case, or plan.

  • taskable_uuid string(uuid) Required

    The taskable UUID

  • task_status_uuid string(uuid) Required

    The task status UUID

  • parent_task_uuid string(uuid)

    The parent task UUID

  • assigned_to_uuids array[string(uuid)]

    Array of account UUIDs

  • custom_fields object

    Additional custom fields

    Additional properties are allowed.

  • group_uuids array[string(uuid)]

    UUIDs of groups that will be assigned when the task is created.

Responses

  • 201 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • name string

      The name of the task

    • description string

      The description of the task

    • priority string

      The priority of the task. Available Options: low, medium, high and highest

    • position integer

      The position of the task

    • due_at string

      The due date of the task

    • status object

      The status of the task. Can be any of the task statuses defined in the firm's settings

      Hide status attributes Show status attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • colour string
      • position integer
      • is_type_completed boolean
      • is_archived boolean
      • is_not_started boolean
    • taskable_type string

      The type of the taskable. Available options: client, case, plan

    • taskable object

      The type of the taskable.

      Hide taskable attributes Show taskable attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • slug string
      • status string
      • type string
      • review_at string
      • assigned_to_uuids array[string]
      • group_uuids array[string]
      • completed_at string
      • value object
        Hide value attributes Show value attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • status_position integer
      • participants_count integer
      • participants string
      • task_board_uuid string
      • plans string
      • custom_fields string
    • author object

      The account that created the task

      Hide author attributes Show author attributes object
      • uuid object
        Hide uuid attributes Show uuid attributes object
        • example string
        • description string
        • collection boolean
      • created_at object
        Hide created_at attributes Show created_at attributes object
        • example string
        • description string
        • collection boolean
      • updated_at object
        Hide updated_at attributes Show updated_at attributes object
        • example string
        • description string
        • collection boolean
      • type object
        Hide type attributes Show type attributes object
        • example string
        • description string
        • collection boolean
      • role object
        Hide role attributes Show role attributes object
        • example string
        • description string
        • collection boolean
      • first_name object
        Hide first_name attributes Show first_name attributes object
        • example string
        • description string
        • collection boolean
      • last_name object
        Hide last_name attributes Show last_name attributes object
        • example string
        • description string
        • collection boolean
      • name object
        Hide name attributes Show name attributes object
        • example string
        • description string
        • collection boolean
      • email object
        Hide email attributes Show email attributes object
        • example string
        • description string
        • collection boolean
      • photo_url object
        Hide photo_url attributes Show photo_url attributes object
        • example string
        • description string
        • collection boolean
      • external_references object
        Hide external_references attributes Show external_references attributes object
        • example string
        • description string
        • collection boolean
    • assigned_to object

      The accounts that the task is assigned to

      Hide assigned_to attributes Show assigned_to attributes object
      • uuid object
        Hide uuid attributes Show uuid attributes object
        • example string
        • description string
        • collection boolean
      • created_at object
        Hide created_at attributes Show created_at attributes object
        • example string
        • description string
        • collection boolean
      • updated_at object
        Hide updated_at attributes Show updated_at attributes object
        • example string
        • description string
        • collection boolean
      • type object
        Hide type attributes Show type attributes object
        • example string
        • description string
        • collection boolean
      • role object
        Hide role attributes Show role attributes object
        • example string
        • description string
        • collection boolean
      • first_name object
        Hide first_name attributes Show first_name attributes object
        • example string
        • description string
        • collection boolean
      • last_name object
        Hide last_name attributes Show last_name attributes object
        • example string
        • description string
        • collection boolean
      • name object
        Hide name attributes Show name attributes object
        • example string
        • description string
        • collection boolean
      • email object
        Hide email attributes Show email attributes object
        • example string
        • description string
        • collection boolean
      • photo_url object
        Hide photo_url attributes Show photo_url attributes object
        • example string
        • description string
        • collection boolean
      • external_references object
        Hide external_references attributes Show external_references attributes object
        • example string
        • description string
        • collection boolean
    • completed_at string

      The date the task was completed

    • completed_by object

      The account that completed the task

      Hide completed_by attributes Show completed_by attributes object
      • uuid object
        Hide uuid attributes Show uuid attributes object
        • example string
        • description string
        • collection boolean
      • created_at object
        Hide created_at attributes Show created_at attributes object
        • example string
        • description string
        • collection boolean
      • updated_at object
        Hide updated_at attributes Show updated_at attributes object
        • example string
        • description string
        • collection boolean
      • type object
        Hide type attributes Show type attributes object
        • example string
        • description string
        • collection boolean
      • role object
        Hide role attributes Show role attributes object
        • example string
        • description string
        • collection boolean
      • first_name object
        Hide first_name attributes Show first_name attributes object
        • example string
        • description string
        • collection boolean
      • last_name object
        Hide last_name attributes Show last_name attributes object
        • example string
        • description string
        • collection boolean
      • name object
        Hide name attributes Show name attributes object
        • example string
        • description string
        • collection boolean
      • email object
        Hide email attributes Show email attributes object
        • example string
        • description string
        • collection boolean
      • photo_url object
        Hide photo_url attributes Show photo_url attributes object
        • example string
        • description string
        • collection boolean
      • external_references object
        Hide external_references attributes Show external_references attributes object
        • example string
        • description string
        • collection boolean
    • custom_fields array[object]

      Any custom fields on the model.

      Hide custom_fields attributes Show custom_fields attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • name string
      • reference string
      • is_required boolean
      • value string
      • selection_options array[string]
      • help_text string
POST /api/v1/task 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/task' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"name":"Check details","description":"Check details","priority":"low","due_at":"2026-01-21","taskable_type":"client","taskable_uuid":"4db681c8-e433-414d-b04d-a828e43622e2","task_status_uuid":"5f789af7-46a4-4daf-9c0e-c0ff1124d8bf","parent_task_uuid":"c512062d-3fd5-49df-9ed8-fdff59fb760e","assigned_to_uuids":["81a0c8ef-8c2b-4fd6-8bc5-4eca9d7cf37b","9c67e746-1107-4cc7-9183-78cbf5193a43","bf72aac4-015a-4965-8841-18b3bbabb29c"],"custom_fields":{"favourite_pet":"Dog"},"group_uuids":["0ea63e05-1bb4-41a6-9f44-3794aee85faf","0352122c-8d96-4687-9632-13ff03313810","e9a3bfeb-79cc-4fb7-8892-d49151f938cf"]}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Check details",
  "description": "Check details",
  "priority": "low",
  "due_at": "2026-01-21",
  "taskable_type": "client",
  "taskable_uuid": "4db681c8-e433-414d-b04d-a828e43622e2",
  "task_status_uuid": "5f789af7-46a4-4daf-9c0e-c0ff1124d8bf",
  "parent_task_uuid": "c512062d-3fd5-49df-9ed8-fdff59fb760e",
  "assigned_to_uuids": [
    "81a0c8ef-8c2b-4fd6-8bc5-4eca9d7cf37b",
    "9c67e746-1107-4cc7-9183-78cbf5193a43",
    "bf72aac4-015a-4965-8841-18b3bbabb29c"
  ],
  "custom_fields": {
    "favourite_pet": "Dog"
  },
  "group_uuids": [
    "0ea63e05-1bb4-41a6-9f44-3794aee85faf",
    "0352122c-8d96-4687-9632-13ff03313810",
    "e9a3bfeb-79cc-4fb7-8892-d49151f938cf"
  ]
}
Response examples (201) 
{
  "name": "Document the transaction",
  "uuid": "df0cb72a-9060-4293-bd5a-a5aab3c755c3",
  "author": {
    "name": {
      "example": "Gareth Thompson",
      "collection": false,
      "description": "Name"
    },
    "role": {
      "example": "client",
      "collection": false,
      "description": "Account role"
    },
    "type": {
      "example": "client",
      "collection": false,
      "description": "Account type"
    },
    "uuid": {
      "example": "f2a1b892-cd32-45c9-9a6f-604b6755d8c4",
      "collection": false,
      "description": "The UUID of the resource."
    },
    "email": {
      "example": "gareth@codepotato.co.uk",
      "collection": false,
      "description": "(Deprecated - Please use the primary email of the account instead). The email of the account."
    },
    "last_name": {
      "example": "Thompson",
      "collection": false,
      "description": "Last name"
    },
    "photo_url": {
      "example": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
      "collection": false,
      "description": "The photo URL of the client"
    },
    "created_at": {
      "example": "2026-01-16T13:10:22+00:00",
      "collection": false,
      "description": "The timestamp of when the resource was created."
    },
    "first_name": {
      "example": "Gareth",
      "collection": false,
      "description": "First name"
    },
    "updated_at": {
      "example": "2026-01-16T13:10:22+00:00",
      "collection": false,
      "description": "The timestamp of when the resource was updated."
    },
    "external_references": {
      "example": "App\\Http\\Resources\\ExternalReferenceResource",
      "collection": true,
      "description": "The external references that have been added to the client."
    }
  },
  "due_at": "2021-01-01 00:00:00",
  "status": {
    "name": "Incomplete",
    "uuid": "215010fb-a017-4c3b-b577-2ab72ac5bdde",
    "colour": "#398898",
    "position": 1,
    "created_at": "2026-01-16T13:10:22+00:00",
    "updated_at": "2026-01-16T13:10:22+00:00",
    "is_archived": false,
    "is_not_started": false,
    "is_type_completed": false
  },
  "position": 1,
  "priority": "high",
  "taskable": {
    "name": "finance",
    "slug": "finance",
    "type": "App\\Http\\Resources\\CasesTypeResource",
    "uuid": "301f7081-9fc2-4274-8975-fa926080b5b5",
    "plans": "App\\Http\\Resources\\Plans\\PlanResource",
    "value": {
      "amount": {
        "example": "4000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      },
      "formatted": {
        "example": "£40.00",
        "description": "Money amount formatted with currency"
      }
    },
    "status": "App\\Http\\Resources\\CasesStatusResource",
    "review_at": "2026-01-16T13:10:22+00:00",
    "created_at": "2026-01-16T13:10:22+00:00",
    "updated_at": "2026-01-16T13:10:22+00:00",
    "group_uuids": [
      "08b74884-40f3-4290-bf6a-07a777ef2d01"
    ],
    "completed_at": "2026-01-16T13:10:22+00:00",
    "participants": "App\\Http\\Resources\\AccountResource",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "status_position": 4,
    "task_board_uuid": "2a8e4720-5a6d-43bb-a131-72b97f58ff55",
    "assigned_to_uuids": [
      "1591fde6-8d7c-45a1-9663-4dbb685f3762"
    ],
    "participants_count": 4
  },
  "created_at": "2026-01-16T13:10:22+00:00",
  "updated_at": "2026-01-16T13:10:22+00:00",
  "assigned_to": {
    "name": {
      "example": "Gareth Thompson",
      "collection": false,
      "description": "Name"
    },
    "role": {
      "example": "client",
      "collection": false,
      "description": "Account role"
    },
    "type": {
      "example": "client",
      "collection": false,
      "description": "Account type"
    },
    "uuid": {
      "example": "cd1faffe-b5e9-4fed-8f28-51c1275412cd",
      "collection": false,
      "description": "The UUID of the resource."
    },
    "email": {
      "example": "gareth@codepotato.co.uk",
      "collection": false,
      "description": "(Deprecated - Please use the primary email of the account instead). The email of the account."
    },
    "last_name": {
      "example": "Thompson",
      "collection": false,
      "description": "Last name"
    },
    "photo_url": {
      "example": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
      "collection": false,
      "description": "The photo URL of the client"
    },
    "created_at": {
      "example": "2026-01-16T13:10:22+00:00",
      "collection": false,
      "description": "The timestamp of when the resource was created."
    },
    "first_name": {
      "example": "Gareth",
      "collection": false,
      "description": "First name"
    },
    "updated_at": {
      "example": "2026-01-16T13:10:22+00:00",
      "collection": false,
      "description": "The timestamp of when the resource was updated."
    },
    "external_references": {
      "example": "App\\Http\\Resources\\ExternalReferenceResource",
      "collection": true,
      "description": "The external references that have been added to the client."
    }
  },
  "description": "Document the transaction",
  "completed_at": "2021-01-01 00:00:00",
  "completed_by": {
    "name": {
      "example": "Gareth Thompson",
      "collection": false,
      "description": "Name"
    },
    "role": {
      "example": "client",
      "collection": false,
      "description": "Account role"
    },
    "type": {
      "example": "client",
      "collection": false,
      "description": "Account type"
    },
    "uuid": {
      "example": "774c4fe8-329c-4cba-b0f9-70f16d0af32b",
      "collection": false,
      "description": "The UUID of the resource."
    },
    "email": {
      "example": "gareth@codepotato.co.uk",
      "collection": false,
      "description": "(Deprecated - Please use the primary email of the account instead). The email of the account."
    },
    "last_name": {
      "example": "Thompson",
      "collection": false,
      "description": "Last name"
    },
    "photo_url": {
      "example": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
      "collection": false,
      "description": "The photo URL of the client"
    },
    "created_at": {
      "example": "2026-01-16T13:10:22+00:00",
      "collection": false,
      "description": "The timestamp of when the resource was created."
    },
    "first_name": {
      "example": "Gareth",
      "collection": false,
      "description": "First name"
    },
    "updated_at": {
      "example": "2026-01-16T13:10:22+00:00",
      "collection": false,
      "description": "The timestamp of when the resource was updated."
    },
    "external_references": {
      "example": "App\\Http\\Resources\\ExternalReferenceResource",
      "collection": true,
      "description": "The external references that have been added to the client."
    }
  },
  "custom_fields": [
    {
      "name": "Favourite Drink",
      "type": "string",
      "uuid": "c8691ce4-d282-48bd-ba72-c9b307701445",
      "value": "Coffee",
      "help_text": "This is the client's favourite drink.",
      "reference": "favourite_drink",
      "created_at": "2026-01-16T13:10:22+00:00",
      "updated_at": "2026-01-16T13:10:22+00:00",
      "is_required": false,
      "selection_options": [
        "Coffee",
        "Tea",
        "Water"
      ]
    }
  ],
  "taskable_type": "case"
}