Application

Update Business Profile

Updates the WhatsApp business profile. Partial semantics — only the fields you send are changed; everything else is preserved as it is on Meta. The change is written straight to Meta, with no caching.

Changing the profile picture

The picture is the one field that is not sent inline. It is a two-step flow:

Upload the image with POST /wa/{app_id}/media/upload (image/jpeg or image/png, up to 5 MB) and keep the returned handle.
Send that handle as profilePictureReference on this call.

The handle is single-use — Meta consumes it the moment the update succeeds, and replaying the same value fails with META_033. To change the picture again, upload the file again for a fresh handle.

profilePictureReference is write-only: it never appears in a response. Reads return the resulting image as profilePictureUrl.

Response shape

With Prefer: return=representation (default) the full profile is re-fetched from Meta and returned. With return=minimal the data key is omitted entirely — the response is exactly { "isSuccess": true }, still HTTP 200. The applied preference is reported in Preference-Applied.

PATCH

{app_id}

profile

Update Business Profile

curl --request PATCH \
  --url https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "about": "Open 09:00-18:00",
  "email": "hello@acme.com",
  "websites": [
    "https://acme.com"
  ]
}
'

import requests

url = "https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/profile"

payload = {
    "about": "Open 09:00-18:00",
    "email": "hello@acme.com",
    "websites": ["https://acme.com"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    about: 'Open 09:00-18:00',
    email: 'hello@acme.com',
    websites: ['https://acme.com']
  })
};

fetch('https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/profile', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/profile",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'about' => 'Open 09:00-18:00',
    'email' => 'hello@acme.com',
    'websites' => [
        'https://acme.com'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/profile"

	payload := strings.NewReader("{\n  \"about\": \"Open 09:00-18:00\",\n  \"email\": \"hello@acme.com\",\n  \"websites\": [\n    \"https://acme.com\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/profile")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"about\": \"Open 09:00-18:00\",\n  \"email\": \"hello@acme.com\",\n  \"websites\": [\n    \"https://acme.com\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/profile")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"about\": \"Open 09:00-18:00\",\n  \"email\": \"hello@acme.com\",\n  \"websites\": [\n    \"https://acme.com\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "about": "<string>",
    "address": "<string>",
    "description": "<string>",
    "email": "jsmith@example.com",
    "profilePictureUrl": "<string>",
    "websites": [
      "<string>"
    ],
    "category": "UNDEFINED"
  },
  "isSuccess": true
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "errors": {
    "code": "WA_VAL_001",
    "group": "VALIDATION",
    "description": "Maximum 2 websites allowed."
  },
  "isSuccess": false
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

Authorizations

Authorization

string

header

required

Secret key in Bearer sk_... format. Server-to-server only — never embed it in a browser or mobile client. The organization is resolved from the key, so organization_id is never passed explicitly.

Headers

Prefer

enum<string>

default:return=representation

return=representation (default) returns the current record; return=minimal returns no body. The response echoes the choice in Preference-Applied.

Available options:

return=representation,

return=minimal

Path Parameters

app_id

string

required

Application ID. Must belong to the organization resolved from your secret key, otherwise the request returns 404 with APPLICATION_004.

Example:

"app_7poyXj8GXuv76e"

Body

application/json

All fields optional. Fields you do not send remain as they are on Meta.

about

string

"About" text.

Maximum string length: 139

address

string

Business address.

Maximum string length: 256

description

string

Business description.

Maximum string length: 512

string<email>

Contact email.

profilePictureReference

string

write-only

Single-use media handle from Upload Media — not a URL and not raw bytes. Consumed by a successful update.

Response

The updated profile, or { "isSuccess": true } alone when Prefer: return=minimal was sent.

data

object

Every field is optional. Fields not set on the profile are dropped from the response.

Show child attributes

isSuccess

enum<boolean>

Available options:

true

Update Business Profile

curl --request PATCH \
  --url https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "about": "Open 09:00-18:00",
  "email": "hello@acme.com",
  "websites": [
    "https://acme.com"
  ]
}
'

import requests

url = "https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/profile"

payload = {
    "about": "Open 09:00-18:00",
    "email": "hello@acme.com",
    "websites": ["https://acme.com"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    about: 'Open 09:00-18:00',
    email: 'hello@acme.com',
    websites: ['https://acme.com']
  })
};

fetch('https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/profile', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/profile",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'about' => 'Open 09:00-18:00',
    'email' => 'hello@acme.com',
    'websites' => [
        'https://acme.com'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/profile"

	payload := strings.NewReader("{\n  \"about\": \"Open 09:00-18:00\",\n  \"email\": \"hello@acme.com\",\n  \"websites\": [\n    \"https://acme.com\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/profile")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"about\": \"Open 09:00-18:00\",\n  \"email\": \"hello@acme.com\",\n  \"websites\": [\n    \"https://acme.com\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.gateway.connexease.com/api/v1/wa/{app_id}/profile")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"about\": \"Open 09:00-18:00\",\n  \"email\": \"hello@acme.com\",\n  \"websites\": [\n    \"https://acme.com\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "about": "<string>",
    "address": "<string>",
    "description": "<string>",
    "email": "jsmith@example.com",
    "profilePictureUrl": "<string>",
    "websites": [
      "<string>"
    ],
    "category": "UNDEFINED"
  },
  "isSuccess": true
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "errors": {
    "code": "WA_VAL_001",
    "group": "VALIDATION",
    "description": "Maximum 2 websites allowed."
  },
  "isSuccess": false
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

Getting Started

Sandbox Public API

Analytics

Application

Template

Media

Developers

Reference

Update Business Profile

Changing the profile picture

Response shape

Authorizations

Headers

Path Parameters

Body

Response