Send catalog by Contact ID (phone number)

post

https://gate.whapi.cloud/business/catalogs/{ContactID}

Sends a link and preview for the catalog of the business identified by ContactID to the recipient specified in to.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

ContactID

string

required

^([\d]{7,15})?(@lid|@s.whatsapp.net)?$

Contact ID

Body Params

Message catalog

Media file to send. You can use preuploaded file or upload file on the fly. Use preupload files if you want to send same file to multiple chats and so as not to disturb the order of messages.

string

required

^[\d-]{9,31}(@[\w\.]{1,})?$

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.

quoted

string

^[A-Za-z0-9._]{4,30}-[A-Za-z0-9._]{4,30}(-[A-Za-z0-9._]{2,30})?(-[A-Za-z0-9._]{2,30})?$

Message ID of the message to be quoted

edit

string

^[A-Za-z0-9._]{4,30}-[A-Za-z0-9._]{4,30}(-[A-Za-z0-9._]{2,30})?(-[A-Za-z0-9._]{2,30})?$

Message ID of the message to be edited

title

string

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

description

string

Description of the catalog

body

string

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

preview_type

string

enum

Defaults to product

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.

preview

string

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

media

File to upload

mime_type

string

Mime type of media

no_encode

boolean

Do not use our encoding

no_cache

boolean

Do not use the cache in a request

mentions

array of strings

The numbers of the mentioned users

mentions

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200Created

400Wrong request parameters

401Need channel authorization for send catalog

404Specified contact not found

429Too many requests

500Internal Error