Cancel a scheduled message

DELETE

/api/v1/messages/scheduled/{id}

curl --request DELETE \
  --url http://localhost:3001/api/v1/messages/scheduled/example \
  --header 'Authorization: <Authorization>'

• Local development
• Production

Cancel a pending scheduled message before it is delivered.

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string

Scheduled-message ID

Responses

200

Cancelled

Media typeapplication/json

object

key

additional properties

any

Example^generated

{}

401

Unauthorized

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

404

Not Found

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

500

Internal Server Error

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}