Update Business Unit

Updates a business unit.

🚧

PUT vs PATCH

PUT is used to fully update an existing resource. It replaces the entire resource with the data provided.
🔸 Any fields not included in the request body will be overwritten to null or their default value.
🔹 Use PUT when you are sending the complete updated object.

PATCH is used to partially update a resource. It modifies only the specified fields without affecting others.
🔸 Fields not included in the PATCH request body will be left unchanged.
🔹 Use PATCH when you only need to update a few fields.

✅ Tip: Always double-check which method to use based on your update logic. Use PUT carefully to avoid unintentionally nulling out data.

Endpoint URL

https://{{base_url}}/api/v2/business-unit

Authentication and rate limits

ItemDetails
Authentication methodOAuth 2.0 Bearer token
Rate limitRate Limit

Requests Example

curl --request PUT \
  --url "https://{{base_url}}/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"
}

Body 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

Language
Click Try It! to start a request and see the response here!