WhatsApp - Lelemon API

Lelemon API

List WhatsApp connections

GET

https://api.lelemon.cl

/v2/whatsapp/connections

Bearer (API key)

Newest first.

Required scope: whatsapp:read.

List WhatsApp connections › query Parameters

limit

integer · min: 1 · max: 100

Default: 20

cursor

string · maxLength: 512

The nextCursor of the previous page, with the same filters.

status

string · enum

Enum values:

pending

connected

failed

revoked

expired

disconnected

List WhatsApp connections › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

List WhatsApp connections › Responses

WhatsappConnectionList

object

string · enum · required

Enum values:

list

hasMore

boolean · required

nextCursor

string | null · required

WhatsappConnection[] · required

GET/v2/whatsapp/connections

curl https://api.lelemon.cl/v2/whatsapp/connections \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "object": "list",
  "hasMore": true,
  "nextCursor": "nextCursor",
  "data": [
    {
      "object": "whatsapp_connection",
      "id": "wcn_4Zq0x8bVw1TqS9mYp3RkLd",
      "phone": "+56912345678",
      "agentId": "agt_4Zq0x8bVw1TqS9mYp3RkLd",
      "connectionType": "coexistence",
      "status": "pending",
      "setupUrl": "setupUrl",
      "expiresAt": "2024-08-25T15:00:00Z",
      "phoneNumberId": "pn_4Zq0x8bVw1TqS9mYp3RkLd",
      "failure": {
        "code": "phone_number_mismatch",
        "message": "The number linked is not the one requested."
      },
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Create a WhatsApp connection link

POST

https://api.lelemon.cl

/v2/whatsapp/connections

Bearer (API key)

Returns a setupUrl for the account owner to link their WhatsApp number. Only the number in phone can be linked: any other one ends the connection as failed and is not attached. When the number is linked, it answers with agentId and the phone_number.connected event is sent. One pending link per account.

Required scope: whatsapp:write.

Create a WhatsApp connection link › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Idempotency-Key

string · minLength: 1 · maxLength: 255

Makes the request safe to retry. Once it starts running, its final response (2xx, 4xx or 5xx) is kept for 24 hours and the same key gets it back, without repeating the effect. A request rejected before it runs leaves the key free. A replayed create omits the secret. The same key with a different request is rejected with 409 idempotency_key_reused.

Create a WhatsApp connection link › Request Body

CreateWhatsappConnection

phone

string · pattern: ^\+[1-9]\d{6,14}$ · required

The number the subaccount will link, in E.164. If they link another one, the connection fails and nothing is attached.

agentId

string · minLength: 1 · maxLength: 64 · required

The agent that will answer on this number.

connectionType

string · enum · required

coexistence keeps the WhatsApp Business app working next to the API; dedicated is API only.

Enum values:

coexistence

dedicated

ConnectionRedirects

language

string · enum

Enum values:

Default: es

Create a WhatsApp connection link › Responses

WhatsappConnection

object

string · enum · required

Enum values:

whatsapp_connection

id

string · required

phone

string · required

agentId

string | null · required

connectionType

string · enum · required

Enum values:

coexistence

dedicated

status

string · enum · required

Enum values:

pending

connected

failed

revoked

expired

disconnected

setupUrl

string | null · required

Send the subaccount here. Only while status is pending.

expiresAt

string | null · date-time · required

phoneNumberId

string | null · required

The phone number it created, once connected.

required

createdAt

string · date-time · required

updatedAt

string · date-time · required

POST/v2/whatsapp/connections

curl https://api.lelemon.cl/v2/whatsapp/connections \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "phone": "+56912345678",
  "agentId": "agt_02y0e5MANqacVbmtn1YyeJ",
  "connectionType": "coexistence",
  "redirects": {
    "success": "https://app.example.com/whatsapp/connected",
    "failure": "https://app.example.com/whatsapp/failed"
  },
  "language": "es"
}'

Example Request Body

{
  "phone": "+56912345678",
  "agentId": "agt_02y0e5MANqacVbmtn1YyeJ",
  "connectionType": "coexistence",
  "redirects": {
    "success": "https://app.example.com/whatsapp/connected",
    "failure": "https://app.example.com/whatsapp/failed"
  },
  "language": "es"
}

json

application/json

Example Responses

{
  "object": "whatsapp_connection",
  "id": "wcn_4Zq0x8bVw1TqS9mYp3RkLd",
  "phone": "+56912345678",
  "agentId": "agt_4Zq0x8bVw1TqS9mYp3RkLd",
  "connectionType": "coexistence",
  "status": "pending",
  "setupUrl": "setupUrl",
  "expiresAt": "2024-08-25T15:00:00Z",
  "phoneNumberId": "pn_4Zq0x8bVw1TqS9mYp3RkLd",
  "failure": {
    "code": "phone_number_mismatch",
    "message": "The number linked is not the one requested."
  },
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Retrieve a WhatsApp connection

GET

https://api.lelemon.cl

/v2/whatsapp/connections/{id}

Bearer (API key)

Returns one WhatsApp connection by id. Use it to refresh a single record you already know; to find records, use the list route. Read only. 404 not_found when the id does not exist or belongs to another organization. You can repeat it safely: it has no side effects.

Required scope: whatsapp:read.

Retrieve a WhatsApp connection › path Parameters

id

string · pattern: ^wcn_[0-9A-Za-z]{22}… · required

The id of the whatsapp connection (wcn_…).

Retrieve a WhatsApp connection › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Retrieve a WhatsApp connection › Responses

WhatsappConnection

object

string · enum · required

Enum values:

whatsapp_connection

id

string · required

phone

string · required

agentId

string | null · required

connectionType

string · enum · required

Enum values:

coexistence

dedicated

status

string · enum · required

Enum values:

pending

connected

failed

revoked

expired

disconnected

setupUrl

string | null · required

Send the subaccount here. Only while status is pending.

expiresAt

string | null · date-time · required

phoneNumberId

string | null · required

The phone number it created, once connected.

required

createdAt

string · date-time · required

updatedAt

string · date-time · required

Revoke a pending WhatsApp connection

DELETE

https://api.lelemon.cl

/v2/whatsapp/connections/{id}

Bearer (API key)

Kills the setupUrl. Only a pending connection can be revoked; to remove a linked number use DELETE /v2/whatsapp/phone-numbers/{id}.

Required scope: whatsapp:write.

Revoke a pending WhatsApp connection › path Parameters

id

string · pattern: ^wcn_[0-9A-Za-z]{22}… · required

The id of the whatsapp connection (wcn_…).

Revoke a pending WhatsApp connection › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Revoke a pending WhatsApp connection › Responses

No data returned

List WhatsApp phone numbers

GET

https://api.lelemon.cl

/v2/whatsapp/phone-numbers

Bearer (API key)

Newest first.

Required scope: whatsapp:read.

List WhatsApp phone numbers › query Parameters

limit

integer · min: 1 · max: 100

Default: 20

cursor

string · maxLength: 512

The nextCursor of the previous page, with the same filters.

List WhatsApp phone numbers › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

List WhatsApp phone numbers › Responses

PhoneNumberList

object

string · enum · required

Enum values:

list

hasMore

boolean · required

nextCursor

string | null · required

PhoneNumber[] · required

Retrieve a WhatsApp phone number

GET

https://api.lelemon.cl

/v2/whatsapp/phone-numbers/{id}

Bearer (API key)

Returns one WhatsApp phone number by id. Use it to refresh a single record you already know; to find records, use the list route. Read only. 404 not_found when the id does not exist or belongs to another organization. You can repeat it safely: it has no side effects.

Required scope: whatsapp:read.

Retrieve a WhatsApp phone number › path Parameters

id

string · pattern: ^pn_[0-9A-Za-z]{22}$ · required

The id of the phone number (pn_…).

Retrieve a WhatsApp phone number › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Retrieve a WhatsApp phone number › Responses

PhoneNumber

object

string · enum · required

Enum values:

phone_number

id

string · required

phone

string | null · required

verifiedName

string | null · required

label

string | null · required

Your own name for the number, such as the branch it serves.

catalogId

string | null · required

The id of the Meta catalog connected to this number. The product, product_list and catalog messages and the catalog templates only send with this catalog. null when none is set.

agentId

string | null · required

active

boolean · required

createdAt

string · date-time · required

updatedAt

string · date-time · required

Disconnect a WhatsApp phone number

DELETE

https://api.lelemon.cl

/v2/whatsapp/phone-numbers/{id}

Bearer (API key)

Detaches the number from the provider and stops its agent. The phone_number.disconnected event is sent.

Required scope: whatsapp:write.

Disconnect a WhatsApp phone number › path Parameters

id

string · pattern: ^pn_[0-9A-Za-z]{22}$ · required

The id of the phone number (pn_…).

Disconnect a WhatsApp phone number › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Disconnect a WhatsApp phone number › Responses

No data returned

Change the agent, label or state of a number

PATCH

https://api.lelemon.cl

/v2/whatsapp/phone-numbers/{id}

Bearer (API key)

Use it to switch the agent that answers (agentId), stop answering without disconnecting (active: false) or name the number, for example by branch (label, null clears it). Only the fields you send change, and the call is idempotent. It does not set business hours or a time zone: those belong to the organization, not to a number, and a field this route does not know is not applied.

Required scope: whatsapp:write.

Change the agent, label or state of a number › path Parameters

id

string · pattern: ^pn_[0-9A-Za-z]{22}$ · required

The id of the phone number (pn_…).

Change the agent, label or state of a number › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Change the agent, label or state of a number › Request Body optional

UpdatePhoneNumber

agentId

string · minLength: 1 · maxLength: 64

The agent that answers on this number from now on.

active

boolean

false stops the agent from answering; true turns it back on.

label

string | null · minLength: 1 · maxLength: 100

Your own name for the number, such as the branch it serves. Send null to clear it.

catalogId

string | null · maxLength: 100 · pattern: ^[0-9]{5,100}$

The id of the catalog you connected to this number in Meta Commerce Manager and WhatsApp Manager. Send null to clear it. The platform cannot ask Meta whether it exists: a wrong id shows up as a failed message with its error.

Change the agent, label or state of a number › Responses

PhoneNumber

object

string · enum · required

Enum values:

phone_number

id

string · required

phone

string | null · required

verifiedName

string | null · required

label

string | null · required

Your own name for the number, such as the branch it serves.

catalogId

string | null · required

The id of the Meta catalog connected to this number. The product, product_list and catalog messages and the catalog templates only send with this catalog. null when none is set.

agentId

string | null · required

active

boolean · required

createdAt

string · date-time · required

updatedAt

string · date-time · required

PATCH/v2/whatsapp/phone-numbers/{id}

curl https://api.lelemon.cl/v2/whatsapp/phone-numbers/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "agentId": "agt_02y0e5MANqacVbmtn1YyeJ",
  "active": true,
  "label": "Sucursal Centro",
  "catalogId": "1234567890"
}'

Example Request Body

{
  "agentId": "agt_02y0e5MANqacVbmtn1YyeJ",
  "active": true,
  "label": "Sucursal Centro",
  "catalogId": "1234567890"
}

json

application/json

Example Responses

{
  "object": "phone_number",
  "id": "pn_4Zq0x8bVw1TqS9mYp3RkLd",
  "phone": "+56 9 1234 5678",
  "verifiedName": "Cafe Central",
  "label": "Sucursal Centro",
  "catalogId": "1234567890",
  "agentId": "agt_4Zq0x8bVw1TqS9mYp3RkLd",
  "active": true,
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Read the cart and catalog settings of a number

GET

https://api.lelemon.cl

/v2/whatsapp/phone-numbers/{id}/commerce-settings

Bearer (API key)

Use it before sending product, product_list or catalog messages to know whether the cart button (isCartEnabled) and the catalog icon (isCatalogVisible) are on, and which catalog the number has (catalogId). Read only and safe to repeat. It asks WhatsApp through the provider, so it answers 503 service_unavailable when the provider does not answer. 404 not_found when the id does not exist or belongs to another organization.

Required scope: whatsapp:read.

Read the cart and catalog settings of a number › path Parameters

id

string · pattern: ^pn_[0-9A-Za-z]{22}$ · required

The id of the phone number (pn_…).

Read the cart and catalog settings of a number › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Read the cart and catalog settings of a number › Responses

CommerceSettings

object

string · enum · required

Enum values:

commerce_settings

phoneNumberId

string · required

isCartEnabled

boolean · required

Whether the cart button shows on the product and catalog messages. WhatsApp turns it on by default.

isCatalogVisible

boolean · required

Whether the catalog icon shows in the chat with the number. WhatsApp turns it off by default.

catalogId

string | null · required

The catalog set on the number, if any.

Turn the cart button or the catalog icon of a number on or off

PATCH

https://api.lelemon.cl

/v2/whatsapp/phone-numbers/{id}/commerce-settings

Bearer (API key)

Use it to show or hide the cart button (isCartEnabled) and the catalog icon in the chat (isCatalogVisible) of one number. Only the fields you send change, and the call is idempotent. It does not connect a catalog: the catalog is created in Meta Commerce Manager and connected in WhatsApp Manager, then you save its id with PATCH /v2/whatsapp/phone-numbers/{id} (catalogId). It writes to WhatsApp through the provider, so it answers 503 service_unavailable when the provider does not accept it.

Required scope: whatsapp:write.

Turn the cart button or the catalog icon of a number on or off › path Parameters

id

string · pattern: ^pn_[0-9A-Za-z]{22}$ · required

The id of the phone number (pn_…).

Turn the cart button or the catalog icon of a number on or off › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Turn the cart button or the catalog icon of a number on or off › Request Body optional

UpdateCommerceSettings

isCartEnabled

boolean

true shows the cart button; false hides it.

isCatalogVisible

boolean

true shows the catalog icon in the chat; false hides it.

Turn the cart button or the catalog icon of a number on or off › Responses

CommerceSettings

object

string · enum · required

Enum values:

commerce_settings

phoneNumberId

string · required

isCartEnabled

boolean · required

Whether the cart button shows on the product and catalog messages. WhatsApp turns it on by default.

isCatalogVisible

boolean · required

Whether the catalog icon shows in the chat with the number. WhatsApp turns it off by default.

catalogId

string | null · required

The catalog set on the number, if any.

Subaccounts Actions