WhatsApp · Conexões — API Zyron Connect Suite

Module

WhatsApp · Connections

Start here: discover available numbers and each connection's actual capabilities before sending.

GET/connections/connections GET/connections/:id/connections/:id GET/connections/:id/health/connections/:id/health GET/connections/:id/profile/connections/:id/profile PATCH/connections/:id/profile/connections/:id/profile

GET/connectionsScope: readOfficial + Basic

List WhatsApp connections and capabilities.

Returns connection_id for automation without exposing tokens or provider credentials. capabilities is the source of truth: Official (Meta) exposes every type and action; the Basic plan connection exposes provider "freemium" with only text and send.

Path parameters

No additional parameters.

Query parameters

No additional parameters.

Body fields

This endpoint does not receive a JSON body.

Ready examples

curl -X GET "https://connect.zyronstack.com/api/v1/connections" \
  -H "Authorization: Bearer SUA_CHAVE_API"

Responses

200	Connections returned.

Response example

{
  "data": [{
    "id": "<CONNECTION_ID>",
    "type": "official",
    "status": "connected",
    "phone_number": "556292498338",
    "capabilities": {
      "provider": "meta_cloud_api",
      "message_types": ["text", "template", "image", "video", "audio", "document", "sticker", "location", "contacts", "interactive", "reaction"],
      "actions": ["send", "mark_read", "media_upload", "media_get", "media_download", "media_delete"]
    }
  }, {
    "id": "9c1d2e3f-4a5b-4c6d-8e7f-0a1b2c3d4e5f",
    "type": "freemium",
    "status": "connected",
    "phone_number": "5511988887777",
    "capabilities": {
      "provider": "freemium",
      "message_types": ["text"],
      "actions": ["send"]
    }
  }]
}

GET/connections/:idScope: readOfficial + Basic

Get one connection.

Use it to confirm status and supported message types.

Path parameters

Field	Type	Description
`id`required	uuid	Connection ID.

Query parameters

No additional parameters.

Body fields

This endpoint does not receive a JSON body.

Ready examples

curl -X GET "https://connect.zyronstack.com/api/v1/connections/<CONNECTION_ID>" \
  -H "Authorization: Bearer SUA_CHAVE_API"

Responses

200	Connection returned.
404	Connection not found.

GET/connections/:id/healthScope: readOfficial (Meta)Requires Official or Agency plan

Official number health and limits.

Queries Meta in real time: quality_rating, messaging_limit_tier, throughput, verification status and health_status with the reason when the number cannot send.

Path parameters

Field	Type	Description
`id`required	uuid	Official connection ID.

Query parameters

No additional parameters.

Body fields

This endpoint does not receive a JSON body.

Ready examples

curl -X GET "https://connect.zyronstack.com/api/v1/connections/<CONNECTION_ID>/health" \
  -H "Authorization: Bearer SUA_CHAVE_API"

Responses

200	Detail returned straight from Meta.
403	upgrade_required: Official/Agency plan feature.
422	Connection is not Official.

Response example

{
  "data": {
    "connection_id": "<CONNECTION_ID>",
    "display_phone_number": "+55 62 9249-8338",
    "verified_name": "Zyron Grid",
    "quality_rating": "GREEN",
    "platform_type": "CLOUD_API",
    "code_verification_status": "VERIFIED",
    "messaging_limit_tier": "TIER_1K",
    "throughput": { "level": "STANDARD" },
    "health_status": { "can_send_message": "AVAILABLE", "entities": [] }
  }
}

GET/connections/:id/profileScope: readOfficial (Meta)Requires Official or Agency plan

Number's business profile.

Returns the profile shown on WhatsApp: about, address, description, email, vertical, websites and picture.

Path parameters

Field	Type	Description
`id`required	uuid	Official connection ID.

Query parameters

No additional parameters.

Body fields

This endpoint does not receive a JSON body.

Ready examples

curl -X GET "https://connect.zyronstack.com/api/v1/connections/<CONNECTION_ID>/profile" \
  -H "Authorization: Bearer SUA_CHAVE_API"

Responses

200	Profile returned.
422	Connection is not Official.

Response example

{
  "data": {
    "connection_id": "<CONNECTION_ID>",
    "about": "Atendimento das 8h às 18h",
    "description": "Automação de WhatsApp para operações comerciais.",
    "email": "contato@zyronstack.com",
    "vertical": "PROF_SERVICES",
    "websites": ["https://connect.zyronstack.com"],
    "profile_picture_url": "https://..."
  }
}

PATCH/connections/:id/profileScope: writeOfficial (Meta)Requires Official or Agency plan

Update the business profile.

Only the sent fields change. about takes up to 139 characters; websites up to 2 http(s) URLs; vertical uses Meta's catalog (RETAIL, PROF_SERVICES, HEALTH…).

Path parameters

Field	Type	Description
`id`required	uuid	Official connection ID.

Query parameters

No additional parameters.

Body fields

Field	Type	Description
`about`optional	string	Profile text (1 to 139 characters).
`address`optional	string	Business address (up to 256).
`description`optional	string	Description (up to 512).
`email`optional	string	Contact email.
`vertical`optional	string	Meta catalog vertical.
`websites`optional	string[]	Up to 2 http(s) URLs.

Ready examples

curl -X PATCH "https://connect.zyronstack.com/api/v1/connections/<CONNECTION_ID>/profile" \
  -H "Authorization: Bearer SUA_CHAVE_API" \
  -H "content-type: application/json" \
  -d '{
  "about": "Atendimento das 8h às 18h",
  "websites": ["https://connect.zyronstack.com"]
}'

Responses

200	Profile updated; returns the current state.
422	Invalid field or non-Official connection.