Guides Use cases API Changelog

Create notification

Create a notification for an invoice, which resends the invoice email to the customer. The required channels body lists the channels to notify on; today only email is supported. Returns a 409 if the invoice is not in unpaid or overdue status, or if the merchant or customer account has no email set.

The request is all-or-nothing: if any requested channel is rate limited, nothing is sent. Each channel can be sent at most once every 24 hours, and not within 24 hours of the invoice being sent. A 429 response lists the limited channels with availableOn and lists the availableChannels that can be sent in a new request.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/invoices.write scope.

POST
/accounts/{accountID}/invoices/{invoiceID}/notifications
curl -X POST "https://api.moov.io/accounts/{accountID}/invoices/{invoiceID}/notifications" \
  -H "Authorization: Bearer {token}" \
  -H "X-Moov-Version: v2026.07.00" \
  -d '{
  "channels": [
    "email"
  ]
}'
import { Moov } from "@moovio/sdk";

const moov = new Moov({
  security: {
    username: "",
    password: "",
  },
});

async function run() {
  const result = await moov.invoices.createInvoiceNotification({
    accountID: "<id>",
    invoiceID: "<id>",
    createInvoiceNotification: {
      channels: [
        "email",
      ],
    },
  });

  console.log(result);
}

run();
declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$createInvoiceNotification = new Components\CreateInvoiceNotification(
    channels: [
        Components\NotificationChannel::Email,
    ],
);

$response = $sdk->invoices->createInvoiceNotification(
    accountID: '<id>',
    invoiceID: '<id>',
    createInvoiceNotification: $createInvoiceNotification

);

if ($response->statusCode === 200) {
    // handle response
}
package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.*;
import io.moov.sdk.models.errors.*;
import io.moov.sdk.models.operations.CreateInvoiceNotificationResponse;
import java.lang.Exception;
import java.util.List;

public class Application {

    public static void main(String[] args) throws GenericError, InvoiceNotificationError, InvoiceNotificationRateLimitedError, Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        CreateInvoiceNotificationResponse res = sdk.invoices().createInvoiceNotification()
                .accountID("<id>")
                .invoiceID("<id>")
                .createInvoiceNotification(CreateInvoiceNotification.builder()
                    .channels(List.of(
                        NotificationChannel.EMAIL))
                    .build())
                .call();

        // handle response
    }
}
from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.invoices.create_invoice_notification(account_id="<id>", invoice_id="<id>", channels=[
        components.NotificationChannel.EMAIL,
    ])

    # Handle response
    print(res)
require 'moov_ruby'

Models = ::Moov::Models
s = ::Moov::Client.new(
  security: Models::Components::Security.new(
    username: '',
    password: ''
  )
)
res = s.invoices.create_invoice_notification(account_id: '<id>', invoice_id: '<id>', create_invoice_notification: Models::Components::CreateInvoiceNotification.new(
  channels: [
    Models::Components::NotificationChannel::EMAIL,
  ]
))

if res.status_code == 200
  # handle response
end
using Moov.Sdk;
using Moov.Sdk.Models.Components;
using System.Collections.Generic;

var sdk = new MoovClient(security: new Security() {
    Username = "",
    Password = "",
});

var res = await sdk.Invoices.CreateInvoiceNotificationAsync(
    accountID: "<id>",
    invoiceID: "<id>",
    body: new CreateInvoiceNotification() {
        Channels = new List<NotificationChannel>() {
            NotificationChannel.Email,
        },
    }
);

// handle response
The request completed successfully, but there is no content to return.

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The server could not understand the request due to invalid syntax.
application/json
Example
{
  "error": "string"
}

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The request contained missing or expired authentication.

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The user is not authorized to make the request.

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The requested resource was not found.

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The request conflicted with the current state of the target resource.
application/json
Example
{
  "error": "string"
}

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The request was well-formed, but the contents failed validation. Check the request for missing or invalid fields.
application/json
Example
{
  "channels": "string"
}

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The request was refused because at least one requested channel is rate limited. No notification was sent.
application/json
Example

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The request failed due to an unexpected error.

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.

Response headers

x-request-id

string required
A unique identifier used to trace requests.

Headers

X-Moov-Version

string
Set this header to v2026.07.00 to use the API described in this specification. When omitted, the server defaults to v2024.01.00, the earliest supported version, which may not match the behavior documented here. An unrecognized well-formed version uses the latest supported version that is not newer than the requested version, when one exists. For example, v2026.08.00 uses v2026.07.00. A malformed value, such as 2022, returns a 404 response.
Possible values: v2026.07.00

Path parameters

accountID

string required

invoiceID

string required

Body

application/json

channels

array<string> required
The channels to send the notification on. Required, must contain at least one channel.
Possible values: email