Update a task

PUT /api/v1/task/{uuid}

Headers

Path parameters

uuid integer Required

application/json

Body

name string

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

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

The taskable UUID
task_status_uuid string

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 updated.

Responses

200 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
  
  Additional properties are allowed.
- taskable_type string
  
  The type of the taskable. Available options: client, case, plan
- taskable object
  
  The type of the taskable.
  
  Additional properties are allowed.
- author object
  
  The account that created the task
  
  Additional properties are allowed.
- assigned_to object
  
  The accounts that the task is assigned to
  
  Additional properties are allowed.
- completed_at string
  
  The date the task was completed
- completed_by object
  
  The account that completed the task
  
  Additional properties are allowed.
- custom_fields array[object]
  
  Any custom fields on the model.
  
  Additional properties are allowed.

PUT /api/v1/task/{uuid}

curl \
 -X PUT https://api.plannrcrm.com/api/v1/task/uuid \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 -d '{"name":"Check details","description":"Check details","priority":"low","due_at":"2020-01-01 00:00:00","taskable_type":"plan","taskable_uuid":"ed1d0eff-1b3f-439e-a1ad-64394558db17","task_status_uuid":"90f8c6ac-da89-4caf-90c6-41fb9a44b013","parent_task_uuid":"f0369c90-b5f6-4539-974c-902dc28000f4","assigned_to_uuids":["6135dbc8-9e0f-4bd6-9452-9b510162254d","33f8bf7e-4e22-4f39-b3ec-b25a58a08892"],"custom_fields":[{"favourite_pet":"Dog"}],"group_uuids":["2cd3cfbd-891f-490c-ae73-18b178ea856b","491d8fb8-7fb6-495a-85b9-949754599322"]}'

Request examples

# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
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": "ed1d0eff-1b3f-439e-a1ad-64394558db17",
  "task_status_uuid": "90f8c6ac-da89-4caf-90c6-41fb9a44b013",
  "parent_task_uuid": "f0369c90-b5f6-4539-974c-902dc28000f4",
  "assigned_to_uuids": [
    "6135dbc8-9e0f-4bd6-9452-9b510162254d",
    "33f8bf7e-4e22-4f39-b3ec-b25a58a08892"
  ],
  "custom_fields": [
    {
      "favourite_pet": "Dog"
    }
  ],
  "group_uuids": [
    "2cd3cfbd-891f-490c-ae73-18b178ea856b",
    "491d8fb8-7fb6-495a-85b9-949754599322"
  ]
}

Response examples (200)

{
  "name": "Document the transaction",
  "uuid": "3b97aa27-9d5c-4ef7-8301-2e95b3ce5bfc",
  "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": "c720d585-f85e-4e56-8534-a93fc16275d1",
      "collection": false,
      "description": "The UUID of the resource."
    },
    "email": {
      "example": "gareth@codepotato.co.uk",
      "collection": false,
      "description": "Email"
    },
    "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-01-17T11:18:30+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": "2025-01-17T11:18:30+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": "36a63cfd-96d2-42ea-9e44-17e8ff4b9c74",
    "colour": "#398898",
    "position": 1,
    "created_at": "2025-01-17T11:18:30+00:00",
    "updated_at": "2025-01-17T11:18:30+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": "6cb2458e-cc05-4754-b167-3e0d11e330da",
    "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",
    "created_at": "2025-01-17T11:18:30+00:00",
    "updated_at": "2025-01-17T11:18:30+00:00",
    "completed_at": "2025-01-17T11:18:30+00:00",
    "participants": "App\\Http\\Resources\\AccountResource",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "status_position": 4,
    "task_board_uuid": "861780d9-f774-4ea1-8d6e-90a0cf48a450",
    "participants_count": 4
  },
  "created_at": "2025-01-17T11:18:30+00:00",
  "updated_at": "2025-01-17T11:18:30+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": "0aa153de-5dda-407e-b628-1e8bb9de8e65",
      "collection": false,
      "description": "The UUID of the resource."
    },
    "email": {
      "example": "gareth@codepotato.co.uk",
      "collection": false,
      "description": "Email"
    },
    "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-01-17T11:18:30+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": "2025-01-17T11:18:30+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": "9e710e43-648c-4004-b09e-999ec239b42d",
      "collection": false,
      "description": "The UUID of the resource."
    },
    "email": {
      "example": "gareth@codepotato.co.uk",
      "collection": false,
      "description": "Email"
    },
    "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-01-17T11:18:30+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": "2025-01-17T11:18:30+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": "eda5e81d-556b-41e7-8212-13e282534dbb",
      "value": "Coffee",
      "help_text": "This is the client's favourite drink.",
      "reference": "favourite_drink",
      "created_at": "2025-01-17T11:18:30+00:00",
      "updated_at": "2025-01-17T11:18:30+00:00",
      "is_required": false,
      "selection_options": [
        "Coffee",
        "Tea",
        "Water"
      ]
    }
  ],
  "taskable_type": "case"
}