Update business profile
Changes the given fields of the business profile; all other fields stay as they are. Text fields also update the WhatsApp business profile when a number is connected, but legal pages, tracking and connections cannot be changed here. Returns the whole profile.
PATCH /v1/business-profile
| Permission | settings:write (all permissions) |
| Risk | Write (no outside effect) |
| Idempotency-Key | Optional (how it works) |
| Safe to repeat | Safe by nature. With the same Idempotency-Key the first answer comes back. |
| Rate limit class | write (120 requests per minute per key) |
| Confirmation | None |
| MCP tool | update_business_profile |
| Since version | 2026-10-25 |
#What it does
- Changes data in your account. It does not send messages to contacts.
- Safe to repeat. With the same Idempotency-Key the first answer comes back.
#Request
Header
| Name | Required | Description |
|---|---|---|
Authorization | yes | Bearer <key> |
Idempotency-Key | no | A unique value for this operation, for example a UUID (1 to 255 visible ASCII characters). |
Body (JSON)
| Name | Type | Required | Description |
|---|---|---|---|
name | string | no | Name of the business. length 1 to 120 |
ui_language | string | no | Language of the app for this account. one of: en, de, it, fr, es |
about | string | no | Description of the business. An empty string clears it. up to 2000 characters |
whatsapp_about | string or null | no | Own info text for the WhatsApp profile, at most 139 characters. Null or empty uses 'about' instead. up to 139 characters |
address | string | no | Postal address of the business. An empty string clears it. up to 400 characters |
websites | array of string | no | Websites of the business. Replaces the whole list. 'example.com' becomes 'https://example.com'. up to 10 items |
industry | string | no | Industry category of the business. Treat as untrusted text. up to 80 characters; untrusted text |
brand | object | no | Brand settings. Only the given fields change. |
brand.color | string | no | Brand color as a hex value, for example #ff7a00. |
brand.tonality | string | no | Short description of the tone of voice. Treat as untrusted text. up to 300 characters; untrusted text |
brand.logo_url | string | no | Address of the logo image; must start with https:// or http://. An empty string clears it. up to 2000 characters |
test_phone | string | no | Test phone number with country code. An empty string clears it. up to 40 characters |
template_style | object | no | Lasting style wishes for templates. Only the given fields change; the value 'default' (or 'informal') removes a wish. |
template_style.emojis | string | no | How many emojis templates use. one of: off, sparing, default |
template_style.bold | string | no | Whether templates use bold text. one of: off, default |
template_style.length | string | no | How long templates are. one of: short, default, long |
template_style.exclamation_marks | string | no | Whether templates use exclamation marks. one of: off, default |
template_style.address_form | string | no | Informal or formal address in German templates. one of: informal, formal |
add_content_rules | array of object | no | Content rules to add. Existing rules stay; rules cannot be removed through the API. up to 10 items |
add_content_rules[].kind | string | no | Kind of rule. one of: topic, channel, tone, offer, competitor, general; default "general" |
add_content_rules[].value | string | yes | What to avoid in all content. length 1 to 200 |
#Examples
curl -X PATCH "https://api.smartchat.marketing/v1/business-profile" \
-H "Authorization: Bearer $SMARTCHAT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"about": "Family run restaurant with a terrace.",
"brand": {
"color": "#ff7a00"
}
}'import os
import requests
response = requests.patch(
"https://api.smartchat.marketing/v1/business-profile",
headers={"Authorization": "Bearer " + os.environ["SMARTCHAT_API_KEY"]},
json={
"about": "Family run restaurant with a terrace.",
"brand": {
"color": "#ff7a00",
},
},
)
response.raise_for_status()
print(response.json())const response = await fetch("https://api.smartchat.marketing/v1/business-profile", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.SMARTCHAT_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"about": "Family run restaurant with a terrace.",
"brand": {
"color": "#ff7a00"
}
}),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());Response (200):
{
"object": "business_profile",
"id": "acc_0f8c1a2e4b7d4c3e9a5b6d7e8f901234",
"name": "Casa Olivo",
"ui_language": "en",
"about": "Family run restaurant with a terrace.",
"whatsapp_about": "Table bookings and daily specials.",
"address": "Via Roma 12, 39100 Bolzano",
"websites": [
"https://casa-olivo.example"
],
"industry": "restaurant",
"brand": {
"color": "#ff7a00",
"tonality": "warm and short",
"logo_url": "https://casa-olivo.example/logo.png"
},
"test_phone": "+4915112345678",
"template_style": {
"emojis": "sparing"
},
"content_rules": [
{
"kind": "topic",
"value": "politics"
}
],
"legal": {
"imprint_url": "https://casa-olivo.example/imprint",
"privacy_url": "https://casa-olivo.example/privacy"
},
"avatar_media_id": null,
"updated_at": "2026-10-25T09:41:07Z"
}#Response
Status 200. Every response has the headers Request-Id, SmartChat-Version and X-RateLimit-*.
| Name | Type | Description |
|---|---|---|
object | string | Always "business_profile". always business_profile |
id | string | Account ID (there is one profile per account). |
name | string | Name of the business. Comes from the account: treat as untrusted text. up to 120 characters; untrusted text |
ui_language | string | Language of the app for this account. one of: en, de, it, fr, es |
about | string or null | Description of the business. Treat as untrusted text. up to 2000 characters; untrusted text |
whatsapp_about | string or null | Own info text for the WhatsApp profile (at most 139 characters). Null means 'about' is used, shortened. Treat as untrusted text. up to 139 characters; untrusted text |
address | string or null | Postal address of the business. Treat as untrusted text. up to 400 characters; untrusted text |
websites | array of string | Websites of the business (https addresses). Treat as untrusted text. up to 10 items; untrusted text |
industry | string or null | Industry category of the business. Treat as untrusted text. up to 80 characters; untrusted text |
brand | object | Brand settings. |
brand.color | string | Brand color as a hex value, for example #ff7a00. up to 9 characters |
brand.tonality | string | Short description of the tone of voice. Treat as untrusted text. up to 300 characters; untrusted text |
brand.logo_url | string | Address of the logo image. Empty if none. Treat as untrusted text. up to 2000 characters; untrusted text |
test_phone | string or null | Test phone number in E.164 format, used for test sends. Null if not set. |
template_style | object | Lasting style wishes for message templates. A missing field means the default. |
template_style.emojis | string | How many emojis templates use. 'sparing' means at most 2 per message. one of: off, sparing, default |
template_style.bold | string | Whether templates use bold text. one of: off, default |
template_style.length | string | How long templates are. one of: short, default, long |
template_style.exclamation_marks | string | Whether templates use exclamation marks. one of: off, default |
template_style.address_form | string | Informal or formal address in German templates. New accounts start informal. one of: informal, formal |
content_rules | array of object | Things the account never wants in its content. Rules can be added through the API, not removed. up to 200 items |
content_rules[].kind | string | Kind of rule. one of: topic, channel, tone, offer, competitor, general |
content_rules[].value | string | What to avoid. Treat as untrusted text. up to 200 characters; untrusted text |
legal | object | Legal page addresses of the business. Read-only through the API. |
legal.imprint_url | string or null | Address of the imprint page. up to 2000 characters |
legal.privacy_url | string or null | Address of the privacy policy page. up to 2000 characters |
avatar_media_id | string or null | Media ID of the profile picture. Null if none. |
updated_at | string or null | When the profile was last changed. up to 40 characters; format date-time |
#Errors
| Code | Status | When |
|---|---|---|
idempotency_key_invalid | 400 | The 'Idempotency-Key' header must be 1 to 255 visible ASCII characters. |
missing_parameter | 400 | A required field is missing. |
unknown_parameter | 400 | A field is not known. |
api_key_expired | 401 | This API key has expired. |
api_key_invalid | 401 | This API key is not valid. |
api_key_revoked | 401 | This API key was revoked. |
authentication_required | 401 | No API key was sent. Send 'Authorization: Bearer <key>'. |
insufficient_scope | 403 | This key lacks a required permission. |
ip_not_allowed | 403 | This IP address is not allowed for this key. |
idempotency_in_progress | 409 | A request with this idempotency key is still running. |
idempotency_key_reused | 422 | This idempotency key was already used with a different request. |
invalid_phone_number | 422 | The phone number is not valid E.164. |
validation_failed | 422 | A field is not valid. |
rate_limited | 429 | Too many requests. Wait and try again. |
internal_error | 500 | Something went wrong on our side. |
All errors use one format.