Skip to content
Pidgely Docs

API reference · Emails

Cancel a scheduled email

POSThttps://api.pidgely.com/emails/{id}/cancel
View as Markdown

Cancels a scheduled email that has not been sent yet. Its recipients end as canceled.

Authorization: Bearer pdg_…. An API key with full_access. A sending_access key gets 401 restricted_api_key.

Path parameters

Name Type Required Description
id string Yes Resource id UUID.

Request

Node.js
import { Pidgely } from 'pidgely';

const pidgely = new Pidgely(process.env.PIDGELY_API_KEY);

const { data, error } = await pidgely.emails.cancel('0199d8a2-6f3c-7c51-9e2a-3b1f0c6d4e21');
console.log(data ?? error);
Python
import os
import pidgely

pidgely.api_key = os.environ["PIDGELY_API_KEY"]

result = pidgely.Emails.cancel("0199d8a2-6f3c-7c51-9e2a-3b1f0c6d4e21")
print(result)
PHP
<?php

require __DIR__ . '/vendor/autoload.php';

$pidgely = Pidgely::client(getenv('PIDGELY_API_KEY'));

$result = $pidgely->emails->cancel('0199d8a2-6f3c-7c51-9e2a-3b1f0c6d4e21');
var_dump($result);
Go
package main

import (
	"context"
	"fmt"
	"os"

	"github.com/pidgely/pidgely-go"
)

func main() {
	ctx := context.Background()
	client := pidgely.NewClient(os.Getenv("PIDGELY_API_KEY"))

	result, err := client.Emails.Cancel(ctx, "0199d8a2-6f3c-7c51-9e2a-3b1f0c6d4e21")
	if err != nil {
		panic(err)
	}
	fmt.Println(result)
}
Ruby
require "pidgely"

Pidgely.api_key = ENV["PIDGELY_API_KEY"]

result = Pidgely::Emails.cancel("0199d8a2-6f3c-7c51-9e2a-3b1f0c6d4e21")
puts result
cURL
curl -X POST 'https://api.pidgely.com/emails/0199d8a2-6f3c-7c51-9e2a-3b1f0c6d4e21/cancel' \
  -H "Authorization: Bearer $PIDGELY_API_KEY"

Response

200 OK

JSON
{
  "object": "email",
  "id": "0199d8a2-6f3c-7c51-9e2a-3b1f0c6d4e21"
}

Response fields

Name Type Required Description
object string Yes Object type.
id string Yes Unique id (UUID). UUID.

Errors

Errors have the shape {"statusCode", "name", "message"}. See Errors for the full list.

Status Name When
401 missing_api_key, restricted_api_key No Authorization: Bearer header, or a sending_access key called an endpoint that needs full_access.
403 invalid_api_key, validation_error The API key is invalid or revoked, or the request is not allowed for this account (unverified domain, plan limit, paused account).
404 not_found The resource does not exist in this account (or the id is not a valid UUID).
422 validation_error A field is missing or invalid; message names it.
429 rate_limit_exceeded Too many requests per second. Wait for Retry-After seconds.
409 not_cancelable The email is not scheduled any more (already sent or canceled).