---
title: "Adds a TaskStatus"
method: POST
path: "/api/v1/task_statuses"
tags: ["task_status"]
---

# Adds a TaskStatus

`POST /api/v1/task_statuses`

## Request

- Base URL: `https://demo.invoiceninja.com`
- URL: `https://demo.invoiceninja.com/api/v1/task_statuses`
- Auth: none declared. Required headers: `X-API-TOKEN`, `X-Requested-With`
- TypeScript: <https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/docs/api/v1/task_statuses/post.ts> (a function with typed inputs; its response is checked against the schema)

Adds a TaskStatusto the system

## Query parameters

- `include` string

## Headers

- `X-API-TOKEN` string, required
- `X-Requested-With` string, required

## Request body

- TaskStatus
  - `id` string: The task status hashed id
  - `name` string: The task status name
  - `color` string: The task status color - hex value
  - `task_status_order` integer: The order of the task status
  - `created_at` number: Timestamp
  - `is_deleted` boolean: A boolean flag determining if the task status has been deleted
  - `updated_at` number: Timestamp
  - `archived_at` number: Timestamp

## Response `200`

Returns the saved TaskStatus object

- TaskStatus
  - `id` string: The task status hashed id
  - `name` string: The task status name
  - `color` string: The task status color - hex value
  - `task_status_order` integer: The order of the task status
  - `created_at` number: Timestamp
  - `is_deleted` boolean: A boolean flag determining if the task status has been deleted
  - `updated_at` number: Timestamp
  - `archived_at` number: Timestamp

## Other responses

- `401`: Authentication error
- `403`: Authorization error
- `422`: Validation error
- `default`: Unexpected Error

## Changes

- **2024-06-06** `8e82a2bd77e0`: 1 breaking, 2 info
  - the response's body type changed from no type to `object` for status `default`
  - added the optional property `code` to the response with the `default` status
  - added the optional property `message` to the response with the `default` status
- **2024-06-05** `e61df65649e2`: 1 breaking, 2 warning
  - the response's body type changed from `object` to no type for status `default`
  - removed the optional property `code` from the response with the `default` status
  - removed the optional property `message` from the response with the `default` status
- **2024-03-07** `71171a40d629`: 6 breaking, 18 info
  - the request's body type changed from no type to `object`
  - the response's body type changed from no type to `object` for status `200`
  - the response's body type changed from no type to `object` for status `401`
  - the response's body type changed from no type to `object` for status `403`
  - …20 more
- **2024-02-18** `88bbc1f38ff7`: 6 breaking, 18 warning
  - the request's body type changed from `object` to no type
  - the response's body type changed from `object` to no type for status `200`
  - the response's body type changed from `object` to no type for status `401`
  - the response's body type changed from `object` to no type for status `403`
  - …20 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/changes/api/v1/task_statuses/post.md)

---

[API](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference.md) - [All operations](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/revisions/bcda1f823746?raw)