---
title: "Atualizar perfil comercial"
method: PATCH
path: "/v1/organizations/me/business-profile"
tags: ["Números"]
---

# Atualizar perfil comercial

`PATCH /v1/organizations/me/business-profile`

## Request

- Base URL: `https://api.ararahq.com`
- URL: `https://api.ararahq.com/v1/organizations/me/business-profile`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/ararahq/apis/ararahq-api/docs/v1/organizations/me/business-profile/patch.ts> (a function with typed inputs; its response is checked against the schema)

Salva localmente e marca `metaSyncStatus = PENDING`. Para publicar no
WhatsApp, chame `/sync`. Permissão: `ADMIN`.

## Request body

- BusinessProfilePatch
  - `displayName` string
  - `vertical` 'AUTO' | 'BEAUTY' | 'APPAREL' | 'EDU' | 'ENTERTAIN' | 'EVENT_PLAN' | 'FINANCE' | 'GROCERY' | 'GOVT' | 'HOTEL' | 'HEALTH' | 'NONPROFIT' | 'PROF_SERVICES' | 'RETAIL' | 'TRAVEL' | 'RESTAURANT' | 'NOT_A_BIZ' | 'OTHER'
  - `description` string
  - `aboutShort` string
  - `email` string
  - `websites` string[]
  - `businessHours` object
  - `profilePhotoUrl` string
  - `awayMessage` string

## Response `200`

Perfil atualizado

- BusinessProfileResponse
  - `id` string, uuid, nullable
  - `displayName` string, nullable
  - `vertical` string, nullable
  - `description` string, nullable
  - `aboutShort` string, nullable
  - `email` string, nullable
  - `websites` string[], nullable
  - `businessHours` object, nullable
  - `profilePhotoUrl` string, nullable
  - `awayMessage` string, nullable
  - `metaSyncStatus` string, required
  - `metaSyncedAt` string, date-time, nullable
  - `metaSyncError` string, nullable
  - `updatedAt` string, date-time, nullable

## Other responses

- `400`: `INVALID_VERTICAL`.
- `401`: Chave inexistente, revogada, expirada, com prefixo errado (`ara_` sem `ara_live_`) ou vinda de IP fora da allowlist. O corpo é o JSON padrão do Spring, sem `error.code`.
- `403`: Dois casos, com corpos diferentes: - Autenticação: header `Authorization` ausente, Bearer que não começa com `ara_`, chave sem a permissão da rota ou rota que não aceita chave de API. Corpo no formato padrão do Spring, sem `error.code`. - Regra de negócio, no formato `{ "error": { ... } }`: `PLAN_FEATURE_LOCKED`, `PLAN_LIMIT_REACHED`, `ACCOUNT_NOT_ACTIVATED`, `NO_DEDICATED_NUMBER`, `ORGANIZATION_SUSPENDED`, `NUMBER_BLOCKED`, `FRAUD_SUSPECTED`, `RESOURCE_FORBIDDEN`, `VIEWER_READ_ONLY`.
- `429`: `RATE_LIMIT_EXCEEDED`: limite geral da API (1.200 leituras ou 3.000 escritas por minuto, por usuário da chave).

## Changes

- **2026-10-12** `d576cd28afc0`: 3 info
  - api tag `Números` added
  - api tag `business-profile` removed
  - added the non-success response with the status `429`
- **2026-09-15** `372d8c2e735d`: 14 breaking, 1 warning, 10 info
  - the request property `aboutShort` became not nullable
  - the request property `awayMessage` became not nullable
  - the request property `businessHours` became not nullable
  - the request property `description` became not nullable
  - …21 more
- **2026-05-25** `4e426b85f784`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ararahq/apis/ararahq-api/changes/v1/organizations/me/business-profile/patch.md)

---

[API](https://skmtc.dev/ararahq/apis/ararahq-api.md) - [All operations](https://skmtc.dev/ararahq/apis/ararahq-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ararahq/apis/ararahq-api/revisions/d576cd28afc0?raw)