Skip to main content
POST
/
v1
/
console
/
access
/
block-emails
Block Emails
curl --request POST \
  --url http://localhost:8000/v1/console/access/block-emails \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "emails": [
    "jsmith@example.com"
  ],
  "expires_at": "2023-11-07T05:31:56Z",
  "reason": "",
  "scope": "all"
}
'
{
  "data": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "expires_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "is_expired": true,
      "reason": "<string>",
      "value": "<string>"
    }
  ],
  "message": "<string>",
  "success": true
}

Authorizations

Authorization
string
header
required

Enter your JWT access token

Body

application/json
emails
string<email>[]
required
Minimum array length: 1
expires_at
string<date-time> | null
reason
string
default:""
scope
enum<string>
default:all
Available options:
all,
content_only

Response

Successful Response

data
BlockRuleResponse · object[] | null
message
string | null
success
boolean
default:true