Create a task

POST /api/v1/task

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

application/json

Body Required

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
due_at string

The task due date
taskable_type string Required

The taskable type. Available Options: client, case, plan
taskable_uuid string Required

The taskable UUID
task_status_uuid string Required

The task status UUID
parent_task_uuid string

The parent task UUID
assigned_to_uuids array[string]

Array of account UUIDs
custom_fields array[string]

Additional custom fields
group_uuids array[string]

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":"2020-01-01 00:00:00","taskable_type":"plan","taskable_uuid":"ce33a43a-597b-48fd-87fe-57e7a487ddc7","task_status_uuid":"f4aa41af-0f17-40b7-8e95-3a70cb606218","parent_task_uuid":"90079070-1e85-4aa9-910b-e5799aaa2477","assigned_to_uuids":["c8ba7380-9f84-4921-98a8-31dded2faa24","eb91790f-ce2c-4bf1-a165-d437c298782e"],"custom_fields":[{"favourite_pet":"Dog"}],"group_uuids":["5143240d-43ad-409d-bbb4-a0a41484d0cc","e1ba4bb5-08ec-4b84-a296-7561e13a3792"]}'

Request examples

# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Check details",
  "description": "Check details",
  "priority": "low",
  "due_at": "2020-01-01 00:00:00",
  "taskable_type": "plan",
  "taskable_uuid": "ce33a43a-597b-48fd-87fe-57e7a487ddc7",
  "task_status_uuid": "f4aa41af-0f17-40b7-8e95-3a70cb606218",
  "parent_task_uuid": "90079070-1e85-4aa9-910b-e5799aaa2477",
  "assigned_to_uuids": [
    "c8ba7380-9f84-4921-98a8-31dded2faa24",
    "eb91790f-ce2c-4bf1-a165-d437c298782e"
  ],
  "custom_fields": [
    {
      "favourite_pet": "Dog"
    }
  ],
  "group_uuids": [
    "5143240d-43ad-409d-bbb4-a0a41484d0cc",
    "e1ba4bb5-08ec-4b84-a296-7561e13a3792"
  ]
}

Response examples (201)

{
  "name": "Document the transaction",
  "uuid": "2795e15a-6fad-49a6-bef4-9cf8b71e9e84",
  "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": "9505a941-b3a9-47ee-8a53-3879064011bc",
      "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": "2025-10-08T10:40:15+01:00",
      "collection": false,
      "description": "The timestamp of when the resource was created."
    },
    "first_name": {
      "example": "Gareth",
      "collection": false,
      "description": "First name"
    },
    "updated_at": {
      "example": "2025-10-08T10:40:15+01: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": "ba58af29-7ea6-47af-964f-1563c5cef0b5",
    "colour": "#398898",
    "position": 1,
    "created_at": "2025-10-08T10:40:15+01:00",
    "updated_at": "2025-10-08T10:40:15+01: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": "089e6501-aaea-4467-8cc3-4db7eab1e257",
    "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": "2025-10-08T10:40:15+01:00",
    "created_at": "2025-10-08T10:40:15+01:00",
    "updated_at": "2025-10-08T10:40:15+01:00",
    "group_uuids": [
      "1ff54eba-adcc-4f3c-a085-ce6c13ffad4c"
    ],
    "completed_at": "2025-10-08T10:40:15+01:00",
    "participants": "App\\Http\\Resources\\AccountResource",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "status_position": 4,
    "task_board_uuid": "6840df6d-75fd-40dd-a658-aa996b0c6be1",
    "assigned_to_uuids": [
      "2ff15f72-b7a3-4672-b451-60ae01144707"
    ],
    "participants_count": 4
  },
  "created_at": "2025-10-08T10:40:15+01:00",
  "updated_at": "2025-10-08T10:40:15+01: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": "41c92584-7e50-4e81-9726-7faea6f165f0",
      "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": "2025-10-08T10:40:15+01:00",
      "collection": false,
      "description": "The timestamp of when the resource was created."
    },
    "first_name": {
      "example": "Gareth",
      "collection": false,
      "description": "First name"
    },
    "updated_at": {
      "example": "2025-10-08T10:40:15+01: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": "a729660e-248d-446b-bb3e-4250217a448a",
      "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": "2025-10-08T10:40:15+01:00",
      "collection": false,
      "description": "The timestamp of when the resource was created."
    },
    "first_name": {
      "example": "Gareth",
      "collection": false,
      "description": "First name"
    },
    "updated_at": {
      "example": "2025-10-08T10:40:15+01: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": "c5e98037-514b-4305-96b2-10d110270a29",
      "value": "Coffee",
      "help_text": "This is the client's favourite drink.",
      "reference": "favourite_drink",
      "created_at": "2025-10-08T10:40:15+01:00",
      "updated_at": "2025-10-08T10:40:15+01:00",
      "is_required": false,
      "selection_options": [
        "Coffee",
        "Tea",
        "Water"
      ]
    }
  ],
  "taskable_type": "case"
}