Revnue API

Update Business Unit

Updates a business unit.

🚧

Warning

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

Endpoint URL

https://dashboard-api.revnue.com/api/v2/business-unit

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

Request Syntax

{
  "company": integer,
  "name": "string",
  "contact_name": "string",
  "contact_email": "string",
  "contact_phone_number": "string",
  "description": "string"
}

Query Parameters

  • id (integer) --

    [REQUIRED] The ID of the business unit.
    The id parameter is passed as part of the request url /business-unit/$id.
    To lookup a specific business unit ID, see the List Business Unit 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 business unit.
    Max characters = 50
    The name of the business unit must be unique per account.

  • contact_name (string) --

    The contact name of the business unit.
    Max characters = 50

  • contact_email (string) --

    The contact email of the business unit.
    Max characters = 254

  • contact_phone_number (string) --

    The contact phone number of the business unit.
    Max characters = 20

  • description (string) --

    The description of the business unit.
    Max characters = 1000

Response Syntax

{
  "id": integer,
  "name": "string",
  "contact_name": "string",
  "contact_email": "string",
  "contact_phone_number": "string",
  "description": "string"
}

Response Fields

  • id (integer) --

    The ID of the business unit.

  • name (string) --

    The name of the business unit.

  • contact_name (string) --

    The contact name of the business unit.

  • contact_email (string) --

    The contact email of the business unit.

  • contact_phone_number (string) --

    The contact phone number of the business unit.

  • description (string) --

    The description of the business unit.