---
title: "Turn inbound receiving on or off"
method: PATCH
path: "/v1/domains/{id}"
tags: ["Domains", "Receiving"]
---

# Turn inbound receiving on or off

`PATCH /v1/domains/{id}`

## Request

- Base URL: `https://smtpfa.st/api`
- URL: `https://smtpfa.st/api/v1/domains/{id}`
- Auth: HTTP bearer

Enable or disable inbound email for a verified domain (paid plans). Returns the MX record to publish and the receiving status: disabled, pending, active or failed. Requires the domain:write scope.

## Path parameters

- `id` string, required

## Request body

- object
  - `receiving_enabled` boolean, required

## Response `200`

Receiving settings

- object
  - `id` string
  - `receiving` DomainReceiving
    - `enabled` boolean
    - `status` 'disabled' | 'pending' | 'active' | 'failed'
    - `mx_record` object
      - `type` string
      - `priority` integer
      - `value` string
    - `published_mx` object[]
      - `priority` integer
      - `exchange` string
    - `competing_mx` string[]

## Other responses

- `400`: Bad request - check your payload
- `401`: Invalid or missing API key
- `402`: Plan limit reached - upgrade the plan to add more
- `403`: Forbidden - domain not verified or insufficient permissions
- `404`: Resource not found
- `409`: Conflict - the resource already exists or changed meanwhile
- `429`: Rate limit exceeded - retry after the period indicated in the Retry-After header
- `500`: Internal server error
- `503`: Error

---

[API](https://skmtc.dev/smtpfa/apis/smtpfast-api.md) · [All operations](https://skmtc.dev/smtpfa/apis/smtpfast-api/llms.txt) · [OpenAPI document](https://skmtc.dev/smtpfa/apis/smtpfast-api/revisions/79dda742f53e?raw)