API di Tempat Platform WhatsApp Business

Kami akan menghentikan On-Premises API. Lihat Proses Penghentian On-Premises API dokumen untuk detailnya, dan untuk mempelajari cara bermigrasi ke Cloud API generasi berikutnya.

Pengaturan Profil Bisnis

/v1/settings/business/profile

Gunakan endpoint /v1/settings/business/profile untuk mengonfigurasi pengaturan profil bisnis berikut: alamat bisnis, deskripsi bisnis, email untuk kontak bisnis, industri bisnis, dan situs web bisnis.

Sebelum Memulai

  • Anda harus menggunakan akun admin untuk mengakses pengaturan profil bisnis.

Mengambil

Buat panggilan API GET untuk mengambil pengaturan profil bisnis Anda.

Contoh

GET /v1/settings/business/profile

Tanggapan yang berhasil menyertakan objek profile yang berisi data profil bisnis. Untuk deskripsi data selengkapnya, lihat daftar Parameter di bawah.

{
   "settings": {
     "business": {
        "profile": {
          "address": "new-business-address",
          "description": "business-description",
          "email": "new-business-email",
          "vertical": "business-industry",
          "websites": [ "website-1", "website-2" ]
        }
      }
}

Jika Anda menemui kesalahan, lihat Pesan Kesalahan dan Status.

Memperbarui Pengaturan Profil Bisnis

Buat panggilan API POST untuk memperbarui pengaturan profil bisnis Anda.

Contoh

POST /v1/settings/business/profile
{
    "address": "your-business-address",
    "description": "your-business-description",
    "email": "your-business-email",
    "vertical": "your-business-industry",
    "websites": [ "your-website-1", "your-website-2" ]
}

Parameter

NamaDeskripsi

address

jenis: String

Alamat bisnis. Maksimum 256 karakter.

description

jenis: String

Deskripsi bisnis. Maksimum 512 karakter.

email

jenis: String

Alamat email (dalam format email yang valid) untuk menghubungi bisnis. Maksimum 128 karakter.

vertical

jenis: String

Industri bisnis. Harus berupa salah satu nilai yang diterima:

  • Automotive
  • Beauty, Spa and Salon
  • Clothing and Apparel
  • Education
  • Entertainment
  • Event Planning and Service
  • Finance and Banking
  • Food and Grocery
  • Public Service
  • Hotel and Lodging
  • Medical and Health
  • Non-profit
  • Professional Services
  • Shopping and Retail
  • Travel and Transportation
  • Restaurant
  • Other

Vertikal bisnis tidak dapat diatur kembali ke nilai kosong setelah dibuat.

websites

jenis: Array string

URL (termasuk http:// atau https://) yang terkait dengan bisnis (misal: situs web, Halaman Facebook, Instagram). Maksimum 2 situs web dengan masing-masing maksimum 256 karakter.

Pembaruan parsial

Jika Anda hanya perlu memperbarui beberapa kolom dengan informasi baru, Anda dapat membuat permintaan yang hanya mengubah kolom yang diperlukan:

  POST /v1/settings/business/profile
{
    "address": "new-business-address",
    "email": "new-business-email"
}

Permintaan yang berhasil akan memberikan Kode Status HTTP 200 OK dan antara null atau {}. Jika Anda menemui kesalahan, lihat Pesan Kesalahan dan Status.