Mailrelay API Reference

Cancel a campaign

PATCH https://{account}/api/v1/sent_campaigns/{id}/cancel

Authentication

Requires an API key sent in the X-AUTH-TOKEN header.

This will stop and permanently cancel the campaign. It can't be resumed later.

Parameters

NameTypeRequiredDescription
id integer Yes ID of the record

Responses

StatusDescription
204 Success
404 Couldn't find record with provided ID.
401 The API key wasn't sent, is invalid or has expired
403 The API key or its user doesn't have permission to use this endpoint, or the request comes from an IP address the key doesn't allow.
429 Too many requests. You have exceeded the rate limit, wait and try again later.
500 An internal error happened. Try again later.
409 Returned when campaign can't be cancelled. This can happen when it has already finished.