Perfil

Nome, recado e foto do número conectado.

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

Meu perfil

GET/v1/instances/{instanceId}/profile
API OnZap
Requisição
curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/profile" \
  -H "X-Instance-Token: $ONZAP_TOKEN"
Resposta
{
  "id": "5511999999999@c.us",
  "name": "Minha Loja",
  "picture": "https://example.com/picture.jpg"
}

Alterar nome do perfil

PUT/v1/instances/{instanceId}/profile/name
API OnZap

Corpo (JSON)

namestringobrigatório
Requisição
curl -X PUT "https://app.onzap.io/v1/instances/SUA_INSTANCIA/profile/name" \
  -H "X-Instance-Token: $ONZAP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My New Name"
  }'
Resposta
{
  "success": true
}

Alterar recado (about)

PUT/v1/instances/{instanceId}/profile/status
API OnZap

Corpo (JSON)

statusstringobrigatório
Requisição
curl -X PUT "https://app.onzap.io/v1/instances/SUA_INSTANCIA/profile/status" \
  -H "X-Instance-Token: $ONZAP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "🎉 Hey there! I am using WhatsApp 🎉"
  }'
Resposta
{
  "success": true
}

Alterar foto do perfil

PUT/v1/instances/{instanceId}/profile/picture
API OnZap

Corpo (JSON)

fileobjectobrigatório
Requisição
curl -X PUT "https://app.onzap.io/v1/instances/SUA_INSTANCIA/profile/picture" \
  -H "X-Instance-Token: $ONZAP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "file": {}
  }'
Resposta
{
  "success": true
}

Remover foto do perfil

DELETE/v1/instances/{instanceId}/profile/picture
API OnZap
Requisição
curl -X DELETE "https://app.onzap.io/v1/instances/SUA_INSTANCIA/profile/picture" \
  -H "X-Instance-Token: $ONZAP_TOKEN"
Resposta
{
  "success": true
}