Create a custom status

POST/statuses

Adds a new custom status, associating it with a project specified in the payload or query.

Example

Use resource IDs from your own project. Keep the API token in your server or CI environment.

TypeScript SDK
HTTP

import { createConfiguration, StatusesApi } from '@testcollab/sdk';

const config = createConfiguration(process.env.TESTCOLLAB_TOKEN!);
const api = new StatusesApi(config);

const result = await api.createStatus({
  "statusCreatePayload": {
    "name": "Checkout smoke tests",
    "priority": 1
  },
  "project": 123
});
console.log(result);

curl --request POST \
  "https://api.testcollab.io/statuses?token=$TESTCOLLAB_TOKEN&project=123" \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "example",
  "description": "example",
  "priority": 123,
  "is_active": true,
  "color": "example",
  "ignore_result": true,
  "enable_report_bug": true
}'

Parameters

Name	Location	Type	Required	Description
`project`	query	integer	Yes	ID of the project this status belongs to.

Request body

Field	Type	Required	Description
`name`	string	Yes	Name of the status
`description`	string	No	Optional description of the status
`priority`	integer	Yes	Priority order of the status (lower number = higher priority)
`is_active`	boolean	No	Whether this status is active and available for use
`color`	string	No	Color code associated with this status
`ignore_result`	boolean	No	Whether to ignore this result in calculations and reports
`enable_report_bug`	boolean	No	Whether to enable the option to report a bug for this status

Response

201 — Custom status created successfully.

Field	Type	Required	Description
`id`	integer	Yes	Unique identifier for the status
`name`	string	Yes	Name of the status
`system_name`	string	Yes	System name of the status, used for internal references
`description`	string	No	Optional description of the status
`priority`	integer	Yes	Priority order of the status (lower number = higher priority)
`is_system_field`	boolean	Yes	Whether this is a system-defined status that cannot be deleted
`is_active`	boolean	Yes	Whether this status is active and available for use
`color`	string	No	Color code associated with this status
`ignore_result`	boolean	No	Whether to ignore this result in calculations and reports
`enable_report_bug`	boolean	No	Whether to enable the option to report a bug for this status
`created_at`	string	No	Date and time when the status was created
`updated_at`	string	No	Date and time when the status was last updated

{
  "id": 123,
  "name": "example",
  "system_name": "example",
  "description": "example",
  "priority": 123,
  "is_system_field": true,
  "is_active": true,
  "color": "example",
  "ignore_result": true
}

Errors

Status	Meaning
`400`	Bad request - Invalid input data or missing project ID
`401`	Unauthorized - Authentication required
`403`	Forbidden - User does not have permission to create statuses