2022-11-20 07:34:38 +01:00
---
title: canonical_email_blocks API methods
description: Block certain email addresses by their hash.
menu:
docs:
name: canonical_email_blocks
parent: methods-admin
identifier: methods-admin-canonical_email_blocks
aliases: [
"/methods/admin/canonical_email_blocks",
"/api/methods/admin/canonical_email_blocks",
]
---
< style >
#TableOfContents ul ul ul {display: none}
< / style >
## List all canonical email blocks {#get}
```http
2022-12-14 22:55:30 +01:00
GET /api/v1/admin/canonical_email_blocks HTTP/1.1
2022-11-20 07:34:38 +01:00
```
**Returns:** Array of [Admin::CanonicalEmailBlock ]({{< relref "entities/Admin_CanonicalEmailBlock" >}} )\
**OAuth:** User token + `admin:read:canonical_email_blocks` \
**Permissions:** Manage Blocks\
**Version history:**\
4.0.0 - added
#### Request
##### Headers
Authorization
: {{< required > }} Provide this header with `Bearer <user token>` to gain authorized access to this API method.
##### Query parameters
2022-12-14 22:55:30 +01:00
max_id
: **Internal parameter.** Use HTTP `Link` header for pagination.
since_id
: **Internal parameter.** Use HTTP `Link` header for pagination.
min_id
: **Internal parameter.** Use HTTP `Link` header for pagination.
2022-11-20 07:34:38 +01:00
limit
2022-12-14 22:55:30 +01:00
: Integer. Maximum number of results to return. Defaults to 100 blocks. Max 200 blocks.
2022-11-20 07:34:38 +01:00
#### Response
##### 200: OK
```json
2022-12-14 22:55:30 +01:00
[
{
"id": "1",
"canonical_email_hash": "b344e55d11b3fc25d0d53194e0475838bf17e9be67ce3e6469956222d9a34f9c"
},
// ...
]
```
Because CanonicalEmailBlock IDs are generally not exposed via any API responses, you will have to parse the HTTP `Link` header to load older or newer results. See [Paginating through API responses ]({{<relref "api/guidelines#pagination">}} ) for more information.
```http
Link: < http: / / mastodon . example / api / v1 / admin / canonical_email_blocks ? limit = 2&max_id=2 > ; rel="next", < http: / / mastodon . example / api / v1 / admin / canonical_email_blocks ? limit = 2&since_id=1 > ; rel="prev"
2022-11-20 07:34:38 +01:00
```
##### 403: Forbidden
Authorized user is missing a permission, or invalid or missing Authorization header
```json
{
"error": "This action is not allowed"
}
```
---
## Show a single canonical email block {#get-one}
```http
2022-12-14 22:55:30 +01:00
GET /api/v1/admin/canonical_email_blocks/:id HTTP/1.1
2022-11-20 07:34:38 +01:00
```
**Returns:** [Admin::CanonicalEmailBlock ]({{< relref "entities/Admin_CanonicalEmailBlock" >}} )\
**OAuth:** User token + `admin:read:canonical_email_blocks` \
**Permissions:** Manage Blocks\
**Version history:**\
4.0.0 - added
#### Request
2023-09-20 10:32:44 +02:00
##### Path parameters
:id
: {{< required > }} String. The ID of the Admin::CanonicalEmailBlock in the database.
2022-11-20 07:34:38 +01:00
##### Headers
Authorization
: {{< required > }} Provide this header with `Bearer <user token>` to gain authorized access to this API method.
#### Response
##### 200: OK
```json
2022-12-14 22:55:30 +01:00
{
"id": "1",
"canonical_email_hash": "b344e55d11b3fc25d0d53194e0475838bf17e9be67ce3e6469956222d9a34f9c"
}
2022-11-20 07:34:38 +01:00
```
##### 403: Forbidden
Authorized user is missing a permission, or invalid or missing Authorization header
```json
{
"error": "This action is not allowed"
}
```
2022-12-14 22:55:30 +01:00
##### 404: Not found
Canonical email block does not exist or was already deleted
```json
{
"error": "Record not found"
}
```
2022-11-20 07:34:38 +01:00
---
## Test {#test}
```http
2022-12-14 22:55:30 +01:00
POST /api/v1/admin/canonical_email_blocks/test HTTP/1.1
2022-11-20 07:34:38 +01:00
```
2022-12-14 22:55:30 +01:00
Canoniocalize and hash an email address.
**Returns:** Array of [Admin::CanonicalEmailBlock ]({{< relref "entities/Admin_CanonicalEmailBlock" >}} )\
2022-11-20 07:34:38 +01:00
**OAuth:** User token + `admin:read:canonical_email_blocks` \
**Permissions:** Manage Blocks\
**Version history:**\
4.0.0 - added
#### Request
##### Headers
Authorization
: {{< required > }} Provide this header with `Bearer <user token>` to gain authorized access to this API method.
##### Form data parameters
2022-12-14 22:55:30 +01:00
email
: {{< required > }} String. The email to canonicalize and hash.
2022-11-20 07:34:38 +01:00
#### Response
##### 200: OK
2022-12-14 22:55:30 +01:00
All matching canonical email blocks are returned.
2022-11-20 07:34:38 +01:00
```json
2022-12-14 22:55:30 +01:00
[
{
"id": "1",
"canonical_email_hash": "b344e55d11b3fc25d0d53194e0475838bf17e9be67ce3e6469956222d9a34f9c"
}
]
2022-11-20 07:34:38 +01:00
```
##### 403: Forbidden
Authorized user is missing a permission, or invalid or missing Authorization header
```json
{
"error": "This action is not allowed"
}
```
2022-12-14 22:55:30 +01:00
##### 500: Server error
<!-- TODO: remove when https://github.com/mastodon/mastodon/issues/21774 is fixed -->
No email was provided
2022-11-20 07:34:38 +01:00
---
## Block a canonical email {#create}
```http
2022-12-14 22:55:30 +01:00
POST /api/v1/admin/canonical_email_blocks HTTP/1.1
2022-11-20 07:34:38 +01:00
```
**Returns:** [Admin::CanonicalEmailBlock ]({{< relref "entities/Admin_CanonicalEmailBlock" >}} )\
**OAuth:** User token + `admin:write:canonical_email_blocks` \
**Permissions:** Manage Blocks\
**Version history:**\
4.0.0 - added
#### Request
##### Headers
Authorization
: {{< required > }} Provide this header with `Bearer <user token>` to gain authorized access to this API method.
##### Form data parameters
email
2022-12-14 22:55:30 +01:00
: {{< required > }} String. The email to canonicalize, hash, and block. If this parameter is provided, `canonical_email_hash` will be ignored.
2022-11-20 07:34:38 +01:00
canonical_email_hash
2022-12-14 22:55:30 +01:00
: String. The hash to test against. If `email` is not provided, this parameter is required.
2022-11-20 07:34:38 +01:00
#### Response
##### 200: OK
2022-12-14 22:55:30 +01:00
Canonical email has been successfully blocked
2022-11-20 07:34:38 +01:00
```json
2022-12-14 22:55:30 +01:00
{
"id": "1",
"canonical_email_hash": "b344e55d11b3fc25d0d53194e0475838bf17e9be67ce3e6469956222d9a34f9c"
}
2022-11-20 07:34:38 +01:00
```
##### 403: Forbidden
Authorized user is missing a permission, or invalid or missing Authorization header
```json
{
"error": "This action is not allowed"
}
```
2022-12-14 22:55:30 +01:00
##### 422: Unprocessable entity
Canonical email hash is already blocked
```json
{
"error":"Validation failed: Canonical email hash has already been taken"
}
```
2022-11-20 07:34:38 +01:00
---
## Delete a canonical email block {#delete}
```http
2022-12-14 22:55:30 +01:00
DELETE /api/v1/admin/canonical_email_blocks/:id HTTP/1.1
2022-11-20 07:34:38 +01:00
```
**Returns:** [Admin::CanonicalEmailBlock ]({{< relref "entities/Admin_CanonicalEmailBlock" >}} )\
**OAuth:** User token + `admin:write:canonical_email_blocks` \
**Permissions:** Manage Blocks\
**Version history:**\
4.0.0 - added
#### Request
2023-09-20 10:32:44 +02:00
##### Path parameters
:id
: {{< required > }} String. The ID of the Admin::CanonicalEmailBlock in the database.
2022-11-20 07:34:38 +01:00
##### Headers
Authorization
: {{< required > }} Provide this header with `Bearer <user token>` to gain authorized access to this API method.
#### Response
##### 200: OK
2022-12-14 22:55:30 +01:00
Canonical email block successfully deleted.
2022-11-20 07:34:38 +01:00
```json
2022-12-14 22:55:30 +01:00
{}
2022-11-20 07:34:38 +01:00
```
##### 403: Forbidden
Authorized user is missing a permission, or invalid or missing Authorization header
```json
{
"error": "This action is not allowed"
}
```
2022-12-14 22:55:30 +01:00
##### 404: Not found
Canonical email block does not exist or was already deleted
```json
{
"error": "Record not found"
}
```
2022-11-20 07:34:38 +01:00
---
## See also
{{< caption-link url = "https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/admin/canonical_email_blocks_controller.rb" caption = "app/controllers/api/v1/admin/canonical_email_blocks_controller.rb" > }}