message

edit scheduled event

Edits an existing scheduled event message with updated details.

post/instances/{id}/client/action/edit-scheduled-event

Request

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

Path parameters

idinteger required

Instance ID

Request body

messageIdstring required

The serialized message ID of the event to edit

namestring

Updated name of the event

startTimeTsinteger

Updated start time as a Unix timestamp

Example request

{
  "messageId": "true_1234567890@c.us_ABCDEF1234567890",
  "name": "Updated Team Meeting",
  "startTimeTs": 1712743200,
  "eventSendOptions": {
    "description": "Updated meeting description",
    "endTimeTs": 1712746800,
    "location": "Conference Room B",
    "callType": "voice"
  }
}

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Scheduled event updated 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": {
      "messageId": "true_1234567890@c.us_ABCDEF1234567890"
    }
  }
}

Changes

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