---
title: "Turn a notification type on or off per channel."
method: PATCH
path: "/notifications/preferences"
tags: ["notifications"]
---

# Turn a notification type on or off per channel.

`PATCH /notifications/preferences`

## Request

- Base URL: `https://api.agentisend.com`
- URL: `https://api.agentisend.com/notifications/preferences`
- Auth: HTTP bearer

The gate is the type — there is no severity to mute instead.

## Headers

- `Idempotency-Key` string
- `Resend-Idempotency-Key` string

## Request body

- PatchNotificationsPreferencesBody
  - `preferences` object[], required
    - `type` 'budget_exhausted' | 'kill_switch_engaged' | 'approvals_pending' | 'trust_state_changed' | 'webhook_endpoint_disabled' | 'domain_verification_lost' | 'domain_verified' | 'appeal_decided' | 'onboarding' | 'api_key_leaked' | 'dmarc_unaligned_source' | 'welcome' | 'billing' | 'support' | 'trial', required
    - `in_app` boolean
    - `email` boolean

## Response `200`

Success

- GetNotificationsPreferencesReply
  - `preferences` object[], required
    - `type` 'budget_exhausted' | 'kill_switch_engaged' | 'approvals_pending' | 'trust_state_changed' | 'webhook_endpoint_disabled' | 'domain_verification_lost' | 'domain_verified' | 'appeal_decided' | 'onboarding' | 'api_key_leaked' | 'dmarc_unaligned_source' | 'welcome' | 'billing' | 'support' | 'trial', required
    - `in_app` boolean, required
    - `email` boolean, required

## Other responses

- `400`: The request is malformed or a field failed validation. Codes: validation_error, invalid_idempotency_key, invalid_cursor, plan_not_purchasable, stripe_signature_invalid, support_upload_rejected, sign_in_check_required.
- `401`: No usable credential was sent. Codes: missing_api_key, session_required, mfa_required.
- `403`: The credential may not do this, or the account or key is stopped. Codes: sending_domain_blocked, young_domain_held, domain_sending_disabled, domain_not_verified, onboarding_recipient_not_a_member, onboarding_sender_unavailable, account_suspended, account_sandboxed, human_action_required, csrf_origin_rejected, charge_not_this_account, invalid_api_key, restricted_api_key, insufficient_role, invite_email_mismatch, domain_scope_violation, dedicated_ip_assigned_by_us, approval_required, staff_review_required, trust_paused, kill_switch_active.
- `409`: The request conflicts with the current state. Codes: domain_already_exists, template_name_taken, template_alias_taken, template_in_use, segment_in_use, contact_resubscribe_required, email_still_scheduled, domain_verified_elsewhere, domain_not_claimable, return_path_subdomain_in_use, overage_not_on_plan, term_not_on_sale, subscription_active, portal_change_unavailable, already_in_account, idempotency_in_flight, idempotency_payload_mismatch, approval_expired, support_closed, support_reopen_expired, support_merge_conflict, support_reply_too_soon.
- `413`: The request body is larger than this operation accepts. Codes: payload_too_large, support_upload_too_large.
- `415`: The request body is not JSON. Codes: unsupported_media_type.
- `429`: A rate, quota or ramp ceiling was reached. Codes: onboarding_daily_cap_reached, trust_throttled, invite_limit_reached, rate_ceiling_exceeded, daily_quota_exceeded, monthly_quota_exceeded, rate_limit_exceeded, support_rate_limited.
- `500`: Something failed on our side. Codes: internal_server_error.

---

[API](https://skmtc.dev/agentisend/apis/agentisend-api.md) · [All operations](https://skmtc.dev/agentisend/apis/agentisend-api/llms.txt) · [OpenAPI document](https://skmtc.dev/agentisend/apis/agentisend-api/revisions/3066dda62a56?raw)