Skip to main content
POST
/
journeys
/
cancel
JavaScript
import Courier from '@trycourier/courier';

const client = new Courier({
  apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted
});

const cancelJourneyResponse = await client.journeys.cancel({ cancelation_token: 'order-1234' });

console.log(cancelJourneyResponse);
import os
from courier import Courier

client = Courier(
api_key=os.environ.get("COURIER_API_KEY"), # This is the default and can be omitted
)
cancel_journey_response = client.journeys.cancel(
cancelation_token="order-1234",
)
print(cancel_journey_response)
package main

import (
"context"
"fmt"

"github.com/trycourier/courier-go"
"github.com/trycourier/courier-go/option"
)

func main() {
client := courier.NewClient(
option.WithAPIKey("My API Key"),
)
cancelJourneyResponse, err := client.Journeys.Cancel(context.TODO(), courier.JourneyCancelParams{
CancelJourneyRequest: courier.CancelJourneyRequestUnionParam{
OfByCancelationToken: &courier.CancelJourneyRequestByCancelationTokenParam{
CancelationToken: "order-1234",
},
},
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", cancelJourneyResponse)
}
package com.courier.example;

import com.courier.client.CourierClient;
import com.courier.client.okhttp.CourierOkHttpClient;
import com.courier.models.journeys.CancelJourneyRequest;
import com.courier.models.journeys.CancelJourneyResponse;

public final class Main {
private Main() {}

public static void main(String[] args) {
CourierClient client = CourierOkHttpClient.fromEnv();

CancelJourneyRequest.ByCancelationToken params = CancelJourneyRequest.ByCancelationToken.builder()
.cancelationToken("order-1234")
.build();
CancelJourneyResponse cancelJourneyResponse = client.journeys().cancel(params);
}
}
require "courier"

courier = Courier::Client.new(api_key: "My API Key")

cancel_journey_response = courier.journeys.cancel(cancel_journey_request: {cancelation_token: "order-1234"})

puts(cancel_journey_response)
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Courier\Client;
use Courier\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('COURIER_API_KEY') ?: 'My API Key');

try {
$cancelJourneyResponse = $client->journeys->cancel(
cancelationToken: 'x', runID: 'x'
);

var_dump($cancelJourneyResponse);
} catch (APIException $e) {
echo $e->getMessage();
}
using System;
using TryCourier;
using TryCourier.Models.Journeys;

CourierClient client = new();

JourneyCancelParams parameters = new()
{
CancelJourneyRequest = new ByCancelationToken("order-1234")
};

var cancelJourneyResponse = await client.Journeys.Cancel(parameters);

Console.WriteLine(cancelJourneyResponse);
courier journeys cancel \
--api-key 'My API Key' \
--cancelation-token x \
--run-id x
curl --request POST \
--url https://api.courier.com/journeys/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cancelation_token": "order-1234"
}
'
{
  "cancelation_token": "order-1234"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for POST /journeys/cancel. Provide EXACTLY ONE of cancelation_token (cancels every run associated with the token) or run_id (cancels a single tenant-scoped run).

cancelation_token
string
required
Minimum string length: 1

Response

Cancelation accepted

202 Accepted body for POST /journeys/cancel, returning the submitted identifier. When called with cancelation_token, returns { cancelation_token }; when called with run_id, returns { run_id, status }.

cancelation_token
string
required