Sign in

v1

latestOpenAPI 3.0.02026-07-14181255304.7 KB
Business

Send catalog by Contact ID (phone number)

post/business/catalogs/{ContactID}

Path parameters

ContactIDstring required

Contact ID

Contact ID

Request body

tostring required

Use the phone number or Chat ID of the contact/group/channel to which you want to send the message. Use Get groups to get the group ID.

quotedstring

Message ID of the message to be quoted

editstring

Message ID of the message to be edited

titlestring

Title of the catalog (if not set, the business name will be used)

descriptionstring

Description of the catalog

bodystring

Message text with link. Example: "Follow this link to view our catalog on WhatsApp". Use %URL% to insert the catalog link.

preview_type'product' | 'business_profile' | 'thumbnail' | 'media' | 'style1' | 'style2' | 'style3' | 'none'

Type of the catalog preview. Use 'product' to set a first product image as preview, 'business_profile' to set the business profile pic as preview, 'thumbnail' to set a custom small jpeg image from 'preview' param as preview, 'media' to set a custom large image from 'media' param as large preview, 'style1' to set a isometric style for catalog preview stub, 'style2' to set a flat style for catalog preview stub, 'style3' to set a WA style for catalog preview stub, or 'none' to not set a preview. If not set, the default is product.

previewstring

Base64 encoded image for small version catalog preview (preview_type=thumbnail). In JPEG format

mime_typestring

Mime type of media

no_encodeboolean

Do not use our encoding

no_cacheboolean

Do not use the cache in a request

mentionsstring[]

The numbers of the mentioned users

Example request

{
  "to": "1234567891@s.whatsapp.net"
}

Response

Created

sentboolean required

Message sent