POST /TrackingCategories/{TrackingCategoryID}

Servers

Path parameters

Name Type Required Description
TrackingCategoryID String Yes

Unique identifier for a TrackingCategory

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

xero-tenant-id String Yes

Xero identifier for Tenant

Idempotency-Key String No

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Request body fields

Name Type Required Description
TrackingCategoryID String No

The Xero identifier for a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9

Name String No

The name of the tracking category e.g. Department, Region (max length = 100)

Option String No

The option name of the tracking option e.g. East, West (max length = 100)

Status String No

The status of a tracking category

Possible values:

  • "ARCHIVED"
  • "DELETED"
  • "ACTIVE"
TrackingOptionID String No

The Xero identifier for a tracking option e.g. dc54c220-0140-495a-b925-3246adc0075f

Options[] Array No

See Tracking Options

Options[].TrackingCategoryID String No

Filter by a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9

Options[].Name String No

The name of the tracking option e.g. Marketing, East (max length = 100)

Options[].Status String No

The status of a tracking option

Possible values:

  • "ARCHIVED"
  • "DELETED"
  • "ACTIVE"
Options[].TrackingOptionID String No

The Xero identifier for a tracking option e.g. ae777a87-5ef3-4fa0-a4f0-d10e1f13073a

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.