Skip to main content
POST
/
workspaces
/
{workspace}
/
contacts
/
{contact}
/
messages
/
video
Video Message
curl --request POST \
  --url https://lancepilot.com/api/v3/workspaces/{workspace}/contacts/{contact}/messages/video \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "file": "http://static.videezy.com/system/resources/previews/000/000/150/original/waterdrop.mp4",
  "caption": "this video send via contact id with json payload"
}'
{
  "status": 201,
  "message": "Resource created successfully.",
  "data": {}
}
This endpoint allows you to send an video message to a contact. You can provide the video in two ways:
  1. Video URL: Pass the video URL in the request body.
  2. Uploaded File: Send the video as a file using multipart/form-data.

​
File Field Requirements

  • file:
    • Required
    • Allowed MIME types: mp4, 3gp
    • Maximum size: 16 MB (max:16384 KB)

​
Request Options

  • Video URL Example (JSON): 
    {
  "file": "https://example.com/video.mp4"
}
  • Uploaded File Example (multipart/form-data): 
    POST /workspaces/{workspace}/contacts/{contact}/messages/video
Content-Type: multipart/form-data

file: [binary video file]
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.

​
contact
string<uuid>
required

ID of the contact.

Body

application/json

Message sending parameters.

​
file
string
required

Video URL.

​
caption
string

Optional caption for the video.

Response

​
status
integer
required
Example:

201

​
message
string
required
Example:

"Resource created successfully."

​
data
object
required

Created resource data.