Revnue API

Update Custom Field Template

Updates a custom field template.

📘

Notice

To add additional custom fields to a custom field template, see the Update Custom Field API.

🚧

Warning

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

Endpoint URL

https://dashboard-api.revnue.com/api/v2/custom-field-template

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/custom-field-template/$id \
  --header 'Authorization: Bearer $BEARER_TOKEN' \
  --header 'Content-Type: application/json' \
  --data-raw '$JSON'

Request Syntax

{
  "company": integer,
  "name": "string",
  "is_active": true | false,
  "fields": [
    {
      "id": integer,
      "name": "string",
      "is_active": true | false
    },
  ]
}

Query Parameters

  • id (integer) --

    [REQUIRED] The ID of the custom field template.
    The id parameter is passed as part of the request url /custom-field-template/$id.
    To lookup a specific custom field template ID, see the List Custom Field Template 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.

  • name (string) --

    [REQUIRED]
    The name of the custom field template.
    Max characters = 50
    The name of the custom field template must be unique per the type of the custom field template.

  • is_active (boolean) --

    [REQUIRED]
    Whether the custom field template is active.
    Options: true | false

  • fields (list) --

    [REQUIRED] all existing custom fields must be included

    • id (integer) --

      [REQUIRED]
      The ID of the custom field.
      To lookup a specific custom field ID, see the List Custom Field Template API.

    • name (string) --

      [REQUIRED]
      The name of the custom field.
      Max characters = 50
      The name of the custom field must be unique per the custom field template.

    • is_active (boolean) --

      [REQUIRED]
      Whether the custom field is active.
      Options: true | false

Response Syntax

{
  "id": integer,
  "name": "string",
  "is_active": true|false,
  "type": "asset" | "contract" | "supplier",
  "fields": [
    {
      "id": integer,
      "name": "string",
      "data_type": "date" | "money" | "number" | "text",
      "is_active": true|false,
      "order": integer
    },
  ]
}

Response Fields

  • id (integer) --

    The ID of the custom field template.

  • name (string) --

    The name of the custom field template.

  • is_active (boolean) --

    Whether the custom field template is active.

  • type (string) --

    The type of the custom field template.

  • fields (list) --

    The list of the custom field properties.

    • id (integer) --

      The ID of the custom field.

    • name (string) --

      The name of the custom field.

    • data_type (string) --

      The data type of the custom field.

    • is_active (boolean) --

      Whether the custom field is active.

    • order (integer) --

      The display order of the custom field.