Create a task

POST /api/v1/task

Headers

application/json

Body Required

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

      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.
POST /api/v1/task 
curl \
 -X POST https://api.plannrcrm.com/api/v1/task \
 -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":"00390bdc-04e1-4429-85d4-ae88b4b7ba5b","task_status_uuid":"e15133ad-22fb-4300-977a-18d0515d4043","parent_task_uuid":"2fda94f9-9416-49bb-b784-2fd232f4790b","assigned_to_uuids":["d684c5a8-fd22-4916-9d72-80fb538e57cb","6df890e4-fc95-4104-a46f-fdf38b4d9caa"],"custom_fields":[{"favourite_pet":"Dog"}]}'
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": "00390bdc-04e1-4429-85d4-ae88b4b7ba5b",
  "task_status_uuid": "e15133ad-22fb-4300-977a-18d0515d4043",
  "parent_task_uuid": "2fda94f9-9416-49bb-b784-2fd232f4790b",
  "assigned_to_uuids": [
    "d684c5a8-fd22-4916-9d72-80fb538e57cb",
    "6df890e4-fc95-4104-a46f-fdf38b4d9caa"
  ],
  "custom_fields": [
    {
      "favourite_pet": "Dog"
    }
  ]
}
Response examples (201) 
{
  "name": "Document the transaction",
  "uuid": "244ce98d-bf87-4dce-8fd9-6fb07a82c28a",
  "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": "38393a39-05cb-4749-a111-57c1aaf3e735",
      "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": "2024-11-20T13:24:01+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": "2024-11-20T13:24:01+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": "76918069-7d5a-41cd-8919-b58176c39ac7",
    "colour": "#398898",
    "position": 1,
    "created_at": "2024-11-20T13:24:01+00:00",
    "updated_at": "2024-11-20T13:24:01+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": "c08975f1-3587-4a89-962c-dcfd33cf0e97",
    "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": "2024-11-20T13:24:01+00:00",
    "updated_at": "2024-11-20T13:24:01+00:00",
    "completed_at": "2024-11-20T13:24:01+00:00",
    "participants": "App\\Http\\Resources\\AccountResource",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "status_position": 4,
    "task_board_uuid": "6ae63bf8-9109-42c5-a1cf-690dc47a8e74",
    "participants_count": 4
  },
  "created_at": "2024-11-20T13:24:01+00:00",
  "updated_at": "2024-11-20T13:24:01+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": "78245646-a320-4cae-8c10-5cbefbcb5263",
      "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": "2024-11-20T13:24:01+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": "2024-11-20T13:24:01+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": "b696f0fb-2f3a-4263-b813-c7c6609a2b53",
      "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": "2024-11-20T13:24:01+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": "2024-11-20T13:24:01+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": "654df57c-3245-46b1-9d82-35c33d6dfe23",
      "value": "Coffee",
      "help_text": "This is the client's favourite drink.",
      "reference": "favourite_drink",
      "created_at": "2024-11-20T13:24:01+00:00",
      "updated_at": "2024-11-20T13:24:01+00:00",
      "is_required": false,
      "selection_options": [
        "Coffee",
        "Tea",
        "Water"
      ]
    }
  ],
  "taskable_type": "case"
}