---
title: "Handle a notification"
method: POST
path: "/customer_notifications/{customer_notification_id}/actions/handle"
tags: ["Customer Notification"]
---

# Handle a notification

`POST /customer_notifications/{customer_notification_id}/actions/handle`

## Request

- Base URL: `https://api.gocardless.com`
- URL: `https://api.gocardless.com/customer_notifications/{customer_notification_id}/actions/handle`
- Auth: HTTP bearer

"Handling" a notification means that you have sent the notification yourself (and
don't want GoCardless to send it).
If the notification has already been actioned, or the deadline to notify has passed,
this endpoint will return an `already_actioned` error and you should not take
further action. This endpoint takes no additional parameters.

## Path parameters

- `customer_notification_id` string, required

## Headers

- `GoCardless-Version` string, required

## Request body

- object
  - `customer_notifications` object

## Response `200`

Action completed successfully

- CustomerNotificationSingleResourceResponse
  - `customer_notifications` CustomerNotification: Customer Notifications represent the notification which is due to be sent to a customer after an event has happened. The event, the resource and the customer to be notified are all identified in the `links` property. Only `payment_created`, `mandate_created` and `subscription_created` notifications are supported. Note that these are ephemeral records - once the notification has been actioned in some way, it is no longer visible using this API. <p class="restricted-notice"><strong>Restricted</strong>: This API is currently only available for approved integrators - please <a href="mailto:help@gocardless.com">get in touch</a> if you would like to use this API.</p>
    - `id` string: The id of the notification.
    - `type` 'payment_created' | 'payment_cancelled' | 'mandate_created' | 'mandate_blocked' | 'subscription_created' | 'subscription_cancelled' | 'instalment_schedule_created' | 'instalment_schedule_cancelled': The type of notification the customer shall receive. Note: today, only `payment_created`, `mandate_created` and `subscription_created` notifications are actually supported. The remaining values are reserved for now. Making a request for an event of any other type will get a `403` `customer_notifications_notification_type_forbidden` error.
    - `action_taken` 'handled': The action that was taken on the notification. Currently this can only be `handled`, which means the integrator sent the notification themselves.
    - `action_taken_at` string, date-time, nullable: Fixed [timestamp](https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times), recording when this action was taken.
    - `action_taken_by` string, nullable: A string identifying the integrator who was able to handle this notification.
    - `links` CustomerNotificationLinks
      - `payment` string: The identifier of the related payment.
      - `mandate` string: The identifier of the related mandate.
      - `refund` string: The identifier of the related refund.
      - `subscription` string: The identifier of the related subscription.
      - `customer` string, required: The customer who should be contacted with this notification.
      - `event` string, required: The event that triggered the notification to be scheduled.

## Other responses

- `400`: Bad Request
- `401`: Unauthorised
- `404`: Not found
- `422`: Validation Error
- `500`: Internal Error

---

[API](https://skmtc.dev/gocardless/apis/gocardless-api.md) - [All operations](https://skmtc.dev/gocardless/apis/gocardless-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gocardless/apis/gocardless-api/revisions/4dd3dae45364?raw)