---
title: "[BETA] set business profile"
method: POST
path: "/instances/{id}/client/action/set-business-profile"
tags: ["business"]
---

# \[BETA\] set business profile

`POST /instances/{id}/client/action/set-business-profile`

## Request

- Base URL: `https://waapi.app/api/v1`
- URL: `https://waapi.app/api/v1/instances/{id}/client/action/set-business-profile`
- Auth: HTTP bearer

Update the authenticated business account's profile. Only provided fields are changed. Profile picture is managed separately. Note: This endpoint is currently in beta and may change without notice.

## Path parameters

- `id` integer, required

## Request body

- object
  - `description` string
  - `email` string
  - `address` string
  - `latitude` number
  - `longitude` number
  - `website` object[]: Up to two websites. Empty array clears them.
    - `url` string
  - `categories` object[]
    - `id` string
  - `businessHours` object: { timezone, note, config: { MON: {mode, hours: [[open, close]]}, ... } }
  - `priceTier` string
  - `serviceAreas` object[]

## Response `200`

Request reached the instance. `data.status` reports whether the action was carried out; on error `data` carries `message` and `explanation`. Payload: Business profile updated successfully.

- object
  - `data` union: The action's outcome. `status: success` carries the payload; `status: error` is an `actionError`.
    - object
      - `status` 'success', required: Whether the instance carried the action out — the authoritative field. In this branch it is always `success`; when the instance refused the action the whole `data` object is an `actionError` with `status: error`, `message` and `explanation`.
      - `instanceId` union
        - integer
        - string
      - `data` object
        - `profile` object: Business profile. Only populated for Business accounts.
          - `description` string, nullable
          - `email` string, nullable
          - `address` string, nullable
          - `website` object[]
            - `url` string
          - `categories` object[]
            - `id` string
            - `localized_display_name` string
          - `businessHours` object, nullable
          - `profileOptions` object, nullable
    - ActionError: Shape of `data` when the instance refused the action. HTTP status is still 200 and the outer `status` is still `success`.
      - `status` 'error', required
      - `message` string
      - `explanation` string
      - `instanceId` union
        - integer
        - string
  - `status` 'success' | 'error': Whether the request reached the instance. `success` here does **not** mean the action was carried out — that is reported by `data.status`, which is the authoritative one. A malformed input arrives as `status: success` with `data.status: error`.

## Other responses

- `401`: Unauthorized — invalid or missing bearer token
- `403`: Forbidden — insufficient permissions or account blocked
- `404`: Not found — instance does not exist or does not belong to you

---

[API](https://skmtc.dev/waapi/apis/waapi-api-2.md) · [All operations](https://skmtc.dev/waapi/apis/waapi-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/waapi/apis/waapi-api-2/revisions/490302f75576?raw)