Updates a category.

🚧

Warning

The HTTP PUT method updates your existing category data. Any fields not included in the request body will be updated to null.

Endpoint URL

https://dashboard-api.revnue.com/api/v2/category

Authentication and rate limits

Item

Details

Authentication method

OAuth 2.0 Bearer token

Rate limit

Rate Limit

Requests Example

curl --request PUT \
  --url 'https://dashboard-api.revnue.com/api/v2/category/$id \
  --header 'Authorization: Bearer $BEARER_TOKEN' \
  --header 'Content-Type: application/json' \
  --data-raw '$JSON'

Request Syntax

{
  "company": integer,
  "category": "string",
  "subcategories": ["string",...]
}

Query Parameters

  • id (integer) --

    [REQUIRED] The ID of the category.
    The id parameter is passed as part of the request url /category/$id.
    To lookup a specific category ID, see the List Category API.

  • company (integer) --

    [REQUIRED]
    The ID of the specific company your API is calling. For accounts with only one company, the default value is 1.
    To lookup a specific company ID, see the List Company API.

  • category (string) --

    [REQUIRED]
    The name of the category.
    Max characters = 50
    The name of the category must be unique per account.

  • subcategories (list of strings) --

    The list of subcategory names.
    Max characters = 50 per subcategory
    The name of each subcategory must be unique per category.

Response Syntax

{
  "id": integer,
  "category": "string",
  "subcategories": ["string",...]
}

Response Fields

  • id (integer) --

    The ID of the category.

  • category (string) --

    The name of the category.

  • subcategories (list) --

    The list of subcategory names.