---
# @generated by sylphx-gen 0.1.0 from contracts@f43687e14b51721de401af0b4dfdca44ad768a0c80ebc87a5f5fd6b3ff19f7d7. Do not edit.
title: "Mailbox OAUTH apps"
description: "The `mailbox_oauth_apps` collection of Sylphx Notify: A Mailbox OAuth App is the platform customer's own OAuth client at Google or Microsoft."
type: reference
product: email
summary: "A Mailbox OAuth App is the platform customer's own OAuth client at Google or Microsoft."
updated: 2026-09-28
order: 900
---

A Mailbox OAuth App is the platform customer's own OAuth client at Google or Microsoft. End users consent to it, so the consent screen names the customer's app and never Sylphx, and every `OAUTH` mailbox of its provider in the environment refreshes its grant against it. An environment has at most one per provider.

**Service** Sylphx Notify · **Resource type** `notify.sylphx.com/MailboxOauthApp` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/mailbox_oauth_apps/{mailbox_oauth_app}` · **Shape** `spec_status`

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/mailbox_oauth_apps/{mailbox_oauth_app}`. |
| `uid` | `string` | `moa_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `MailboxOauthAppSpec` | Desired state. Required. |
| `status` | `MailboxOauthAppStatus` | Observed state. Output only. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/mailbox_oauth_apps#get) | Gets a mailbox OAuth app. |
| `GET` | [`list`](/docs/api/mailbox_oauth_apps#list) | Lists mailbox OAuth apps. |
| `POST` | [`create`](/docs/api/mailbox_oauth_apps#create) | Creates a mailbox OAuth app. |
| `PATCH` | [`update`](/docs/api/mailbox_oauth_apps#update) | Updates a mailbox OAuth app. |
| `DELETE` | [`delete`](/docs/api/mailbox_oauth_apps#delete) | Deletes a mailbox OAuth app; refused while a mailbox uses it. |

## get

Gets a mailbox OAuth app.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailbox_oauth_apps/mailbox-oauth-app` · scope `notify:read` · effect `read` · [Request, response and examples](/docs/api/mailbox_oauth_apps/get)

## list

Lists mailbox OAuth apps.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailbox_oauth_apps` · scope `notify:read` · effect `read` · paginated · [Request, response and examples](/docs/api/mailbox_oauth_apps/list)

## create

Creates a mailbox OAuth app.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailbox_oauth_apps` · scope `notify:write` · effect `write` · [Request, response and examples](/docs/api/mailbox_oauth_apps/create)

## update

Updates a mailbox OAuth app.

`PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailbox_oauth_apps/mailbox-oauth-app` · scope `notify:write` · effect `write` · [Request, response and examples](/docs/api/mailbox_oauth_apps/update)

## delete

Deletes a mailbox OAuth app; refused while a mailbox uses it.

`DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailbox_oauth_apps/mailbox-oauth-app` · scope `notify:write` · effect `destructive` · [Request, response and examples](/docs/api/mailbox_oauth_apps/delete)