---
title: "Disable a block"
method: POST
path: "/blocks/{block_id}/actions/disable"
tags: ["Block"]
---

# Disable a block

`POST /blocks/{block_id}/actions/disable`

## Request

- Base URL: `https://api.gocardless.com`
- URL: `https://api.gocardless.com/blocks/{block_id}/actions/disable`
- Auth: HTTP bearer

Disables a block so that it no longer will prevent mandate creation.

## Path parameters

- `block_id` string, required

## Headers

- `GoCardless-Version` string, required

## Response `200`

Action completed successfully

- BlockSingleResourceResponse
  - `blocks` Block: Blocks are created to prevent certain customer details from being used when creating mandates. The details used to create blocks can be exact matches, like a bank account or an email, or a more generic match such as an email domain or bank name. Please be careful when creating blocks for more generic matches as this may block legitimate payers from using your service. New block types may be added over time. A block is in essence a simple rule that is used to match against details in a newly created mandate. If there is a successful match then the mandate is transitioned to a "blocked" state. Please note: - Payments and subscriptions cannot be created against a mandate in blocked state. - A mandate can never be transitioned out of the blocked state. The one exception to this is when blocking a 'bank_name'. This block will prevent bank accounts from being created for banks that match the given name. To ensure we match bank names correctly an existing bank account must be used when creating this block. Please be aware that we cannot always match a bank account to a given bank name. <p class="notice"> This API is currently only available for GoCardless Protect+ integrators - please <a href="mailto:help@gocardless.com">get in touch</a> if you would like to use this API. </p>
    - `id` string: Unique identifier, beginning with "BLC".
    - `block_type` 'email' | 'email_domain' | 'bank_account' | 'bank_name': Type of entity we will seek to match against when blocking the mandate. This can currently be one of 'email', 'email_domain', 'bank_account', or 'bank_name'.
    - `reason_type` 'identity_fraud' | 'no_intent_to_pay' | 'unfair_chargeback' | 'other': The reason you wish to block this payer, can currently be one of 'identity_fraud', 'no_intent_to_pay', 'unfair_chargeback'. If the reason isn't captured by one of the above then 'other' can be selected but you must provide a reason description.
    - `reason_description` string, nullable: This field is required if the reason_type is other. It should be a description of the reason for why you wish to block this payer and why it does not align with the given reason_types. This is intended to help us improve our knowledge of types of fraud.
    - `resource_reference` string: This field is a reference to the value you wish to block. This may be the raw value (in the case of emails or email domains) or the ID of the resource (in the case of bank accounts and bank names). This means in order to block a specific bank account (even if you wish to block generically by name) it must already have been created as a resource.
    - `active` boolean, nullable: Shows if the block is active or disabled. Only active blocks will be used when deciding if a mandate should be blocked.
    - `created_at` string, date-time: Fixed [timestamp](https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times), recording when this resource was created.
    - `updated_at` string, date-time: Fixed [timestamp](https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times), recording when this resource was updated.

## 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)