Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
business
/
profile
Dados da conta business
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/business/profile \
  --header 'Client-Token: <api-key>'
{
  "description": "<string>",
  "address": "<string>",
  "email": "<string>",
  "websites": [
    {}
  ],
  "categories": [
    {}
  ],
  "businessHours": {},
  "hasCoverPhoto": true
}

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Este método é responsável por retornar os dados do perfil da conta WhatsApp Business, incluindo descrição, endereço, email, websites, categorias e horário de funcionamento.

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Query Parameters

​
phone
string
obrigatório
Telefone da conta business

​
Response

​
200

​
description
string
Descrição da empresa
​
address
string
Endereço da empresa
​
email
string
Email da empresa
​
websites
array
Websites da empresa
​
categories
array
Categorias da empresa
​
businessHours
object
Horário de funcionamento
​
hasCoverPhoto
boolean
Indica se a conta possui foto de capa
{
  "description": "...",
  "address": "...",
  "email": "...",
  "websites": ["..."],
  "categories": [
    {
      "displayName": "...",
      "label": "...",
      "id": "..."
    }
  ],
  "businessHours": {
    "timezone": "America/Sao_Paulo",
    "days": [
      {
        "dayOfWeek": "MONDAY",
        "openTime": "08:00",
        "closeTime": "18:00"
      }
    ],
    "mode": "specificHours"
  },
  "hasCoverPhoto": false
}

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.