Skip to main content
POST
Image Message
This endpoint allows you to send an image message to a contact. You can provide the image in two ways:
  1. Image URL: Pass the image URL in the request body.
  2. Uploaded File: Send the image as a file using multipart/form-data.

File Field Requirements

  • file:
    • Required
    • Allowed MIME types: jpg, png
    • Maximum size: 5.12 MB (max:5120 KB)

Request Options

  • Image URL Example (JSON):
  • Uploaded File Example (multipart/form-data):
Choose the method that best fits your use case.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspace
string<uuid>
required

ID of the workspace.

number
string<uuid>
required

Number of the contact.

Body

application/json

Message sending parameters.

file
string
required

Image URL.

caption
string

Optional caption for the image.

Response

status
integer
required
Example:

201

message
string
required
Example:

"Resource created successfully."

data
object
required

Created resource data.