Skip to main content
PATCH
Update email sign-in application

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Headers

Email-Box-SID
string

Email server (em_bx_...) the call is for, from search_email_boxes. Omitted: the primary server.

Pattern: ^em_bx_[A-Za-z0-9]{12}$

Path Parameters

sid
string
required

Path segment {sid}.

Required string length: 18
Pattern: ^em_oa_

Body

application/json

Request body of update_email_oauth_app.

name
string
Required string length: 1 - 255
microsoft_tenant
string | null

microsoft only: common, organizations, a tenant id or a verified domain.

Maximum string length: 255
callback_host
string | null

A custom domain of the team issued through the platform, which the provider redirects to; null: the platform's connect address.

Maximum string length: 255
google_pubsub_topic
string | null

google only: projects/{project}/topics/{topic} in the application's own project.

Maximum string length: 255
is_default
boolean
publishing_status
enum<string>
Available options:
unknown,
testing,
unverified,
verified
client_secret
string

A new client secret; the credentials are checked at the provider in the call. Never read back.

Required string length: 1 - 1024

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required