message

send event message

Creates and sends a calendar event message to a specified chat.

post/instances/{id}/client/action/send-event

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances/{id}/client/action/send-event
  • Auth: HTTP bearer

Path parameters

idinteger required

Instance ID

Request body

chatIdstring required

Chat ID <countrycode_short><usernumber>@c.us or @g.us for groups

namestring required

Name of the event

descriptionstring

Optional description of the event

locationstring

Optional location of the event

callType'video' | 'voice' | 'none'

Optional call type for the event

Example request

{
  "chatId": "50664083362@c.us",
  "name": "Team Meeting",
  "description": "Weekly sync meeting",
  "location": "Conference Room A",
  "callType": "video"
}

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Event message sent successfully.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

{
  "status": "success",
  "data": {
    "status": "success",
    "data": {
      "type": "event_creation"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.