Chilkat Online Tools

Go / Braze Endpoints / Delete Scheduled Messages

Back to Collection Items

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    http := chilkat.NewHttp()
    var success bool

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "schedule_id": "schedule_identifier"
    // }

    json := chilkat.NewJsonObject()
    json.UpdateString("schedule_id","schedule_identifier")

    http.SetRequestHeader("Content-Type","application/json")
    // Adds the "Authorization: Bearer {{api_key}}" header.
    http.SetAuthToken("{{api_key}}")

    resp := http.PostJson3("https://rest.iad-01.braze.com/messages/schedule/delete","application/json",json)
    if http.LastMethodSuccess() == false {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        json.DisposeJsonObject()
        return
    }

    fmt.Println(resp.StatusCode())
    fmt.Println(resp.BodyStr())
    resp.DisposeHttpResponse()

    http.DisposeHttp()
    json.DisposeJsonObject()

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Authorization: Bearer {{api_key}}"
	-d '{
  "schedule_id": "schedule_identifier"
}'
https://rest.iad-01.braze.com/messages/schedule/delete

Postman Collection Item JSON

{
  "name": "Delete Scheduled Messages",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "type": "text",
        "value": "Bearer {{api_key}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"schedule_id\": \"schedule_identifier\"\n}\n"
    },
    "url": {
      "raw": "https://{{instance_url}}/messages/schedule/delete",
      "protocol": "https",
      "host": [
        "{{instance_url}}"
      ],
      "path": [
        "messages",
        "schedule",
        "delete"
      ]
    },
    "description": "The delete scheduled messages endpoint allows you to cancel a message that you previously scheduled _before_ it has been sent.\n\n### Request Parameters\n| Parameter | Required | Data Type | Description |\n| --------- | ---------| --------- | ----------- |\n| `schedule_id` | Required | String | The schedule_id to delete (obtained from the response to create schedule) |\n\n## Request Components\n- [Campaign Identifier](https://www.braze.com/docs/api/identifier_types/)"
  },
  "response": [
  ]
}