Set sort order for custom fields

POST/customfields/setSortOrder

Set sort order for custom fields

Example

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

TypeScript SDK

example.ts

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

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

const result = await api.setCustomFieldsSortOrder({
  "customFieldsSortOrderPayload": {
    "company": 123,
    "id": 123,
    "entity": "example",
    "oldPosition": 123,
    "newPosition": 123
  }
});
console.log(result);

HTTP

curl --request POST \
  "https://api.testcollab.io/customfields/setSortOrder?token=$TESTCOLLAB_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
  "company": 123,
  "id": 123,
  "entity": "example",
  "oldPosition": 123,
  "newPosition": 123
}'

Request body

Field	Type	Required	Description
company	number	Yes	—
id	number	Yes	—
entity	string	Yes	—
oldPosition	number	Yes	—
newPosition	number	Yes	—

Response

200 — Action status details

Field	Type	Required	Description
status	boolean	Yes	—
created_id	number	Yes	—
message	string	No	—

Illustrative response

{
  "status": true,
  "created_id": 123,
  "message": "example"
}

Errors

Status	Meaning
403	Forbidden

Next steps

• Browse cases and suites
• Authentication
• Handle errors