Skip to main content
POST
/
digests
/
schedules
/
{schedule_id}
/
trigger
JavaScript
import Courier from '@trycourier/courier';

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

await client.digests.schedules.release('schedule_id');
import os
from courier import Courier

client = Courier(
api_key=os.environ.get("COURIER_API_KEY"), # This is the default and can be omitted
)
client.digests.schedules.release(
"schedule_id",
)
package main

import (
"context"

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

func main() {
client := courier.NewClient(
option.WithAPIKey("My API Key"),
)
err := client.Digests.Schedules.Release(context.TODO(), "schedule_id")
if err != nil {
panic(err.Error())
}
}
package com.courier.example;

import com.courier.client.CourierClient;
import com.courier.client.okhttp.CourierOkHttpClient;
import com.courier.models.digests.schedules.ScheduleReleaseParams;

public final class Main {
private Main() {}

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

client.digests().schedules().release("schedule_id");
}
}
require "courier"

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

result = courier.digests.schedules.release("schedule_id")

puts(result)
<?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 {
$result = $client->digests->schedules->release('schedule_id');

var_dump($result);
} catch (APIException $e) {
echo $e->getMessage();
}
using TryCourier;
using TryCourier.Models.Digests.Schedules;

CourierClient client = new();

ScheduleReleaseParams parameters = new() { ScheduleID = "schedule_id" };

await client.Digests.Schedules.Release(parameters);
courier digests:schedules release \
--api-key 'My API Key' \
--schedule-id schedule_id
curl --request POST \
--url https://api.courier.com/digests/schedules/{schedule_id}/trigger \
--header 'Authorization: Bearer <token>'
{
  "message": "Unauthorized"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

schedule_id
string
required

The ID of the digest schedule to release, in the form sch/{uuid}. The value must be URL-encoded (e.g. sch%2F00000000-0000-0000-0000-000000000000).

Response

The digest schedule was released. A 204 is also returned when the schedule currently has no in-progress digest instances to release.