Perfil comercial

Descrição, endereço, site e foto do perfil comercial.

Basehttps://app.onzap.io/v1/instances/{instanceId}AuthX-Instance-Token: SEU_TOKEN

Perfil comercial

GET/v1/instances/{instanceId}/business-profile
Só API oficial
Requisição
curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/business-profile" \
  -H "X-Instance-Token: $ONZAP_TOKEN"
Resposta

Perfil

{
  "data": [
    {
      "about": "Disponível",
      "address": "Av. Paulista, 1000 - São Paulo, SP",
      "description": "Atendimento de segunda a sexta, das 9h às 18h.",
      "email": "[email protected]",
      "profile_picture_url": "https://pps.whatsapp.net/v/t61.24694-24/foto.jpg",
      "vertical": "RETAIL",
      "websites": [
        "texto"
      ]
    }
  ]
}

Alterar perfil comercial

PATCH/v1/instances/{instanceId}/business-profile
Só API oficial

Só os campos enviados mudam.

Corpo (JSON)

aboutstringopcional
Recado.
addressstringopcional
descriptionstringopcional
emailstringopcional
verticalstringopcional
Ramo (ex.: RETAIL, HEALTH, EDU).
websitesarray de stringopcional
Requisição
curl -X PATCH "https://app.onzap.io/v1/instances/SUA_INSTANCIA/business-profile" \
  -H "X-Instance-Token: $ONZAP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta

Perfil atualizado

{
  "data": [
    {
      "about": "Disponível",
      "address": "Av. Paulista, 1000 - São Paulo, SP",
      "description": "Atendimento de segunda a sexta, das 9h às 18h.",
      "email": "[email protected]",
      "profile_picture_url": "https://pps.whatsapp.net/v/t61.24694-24/foto.jpg",
      "vertical": "RETAIL",
      "websites": [
        "texto"
      ]
    }
  ]
}

Alterar foto do perfil comercial

PUT/v1/instances/{instanceId}/business-profile/picture
Só API oficial

JPG ou PNG em base64 (quadrada, mínimo 192×192).

Corpo (JSON)

fileobjectobrigatório
file.datastringobrigatório
Imagem em base64 (pode ter o prefixo data:).
file.mimetypestringopcional
Valores:image/jpegimage/png
Requisição
curl -X PUT "https://app.onzap.io/v1/instances/SUA_INSTANCIA/business-profile/picture" \
  -H "X-Instance-Token: $ONZAP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "file": {
      "data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="
    }
  }'
Resposta

Perfil atualizado

{
  "data": [
    {
      "about": "Disponível",
      "address": "Av. Paulista, 1000 - São Paulo, SP",
      "description": "Atendimento de segunda a sexta, das 9h às 18h.",
      "email": "[email protected]",
      "profile_picture_url": "https://pps.whatsapp.net/v/t61.24694-24/foto.jpg",
      "vertical": "RETAIL",
      "websites": [
        "texto"
      ]
    }
  ]
}