Update an OAuth app

Updates an OAuth app’s credentials, branding or return URLs. At least one field is required. A rotated secret replaces the old one immediately, so update the provider first. return_urls replaces the whole list.

PATCH/oauth-apps/{app_id}

Authorization

AuthorizationBearer token (API key) · headerrequired

Pass an AI Inbx API key as a Bearer token.

Path parameters

app_idstringrequired

The prefixed OAuth app ID.

matches ^[a-z]+_[0-9a-f]{32}$

Request body

requiredapplication/json

namestring

min length 1 · max length 100

client_idstring

min length 1 · max length 500

client_secretstring

min length 1 · max length 2000

tenantstring | any

Show properties

Any of:

string

string

any

any

pubsub_topicstring | any

Show properties

Any of:

string

string

any

any

accentstring | any

Show properties

Any of:

string

string

any

any

taglinestring | any

Show properties

Any of:

string

string

any

any

support_emailstring<email> | any

Show properties

Any of:

string<email>

string<email>

any

any

logo_urlstring<uri> | any

Show properties

Any of:

string<uri>

string<uri>

any

any

return_urlsstring<uri>[]

The pages a connect link may return to. Replaced whole on update.

max items 20

Responses

200Success.

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

providerstringrequired

Allowed:googlemicrosoft

namestringrequired

slugstringrequired

client_idstringrequired

tenantstring | anyrequired

Show properties

Any of:

string

string

any

any

pubsub_topicstring | anyrequired

Show properties

Any of:

string

string

any

any

accentstring | anyrequired

Show properties

Any of:

string

string

any

any

taglinestring | anyrequired

Show properties

Any of:

string

string

any

any

support_emailstring<email> | anyrequired

Show properties

Any of:

string<email>

string<email>

any

any

logo_urlstring<uri> | anyrequired

A logo linked from the customer's own server. An uploaded one is served from us and is not linkable through the API.

Show properties

Any of:

string<uri>

string<uri>

any

any

connect_urlstring<uri>required

return_urlsstring<uri>[]required

The pages a connect link — `connect_url` + `/start?return_to=…` — may return to. Matched on origin and path.

redirect_uristring<uri>required

push_endpointstring<uri> | anyrequired

Show properties

Any of:

string<uri>

string<uri>

any

any

created_atstring<date-time>required

matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

400The request is invalid.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

401The API key is missing or invalid.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

403The API key does not have the required scope.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

404The requested resource does not exist.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

409The request conflicts with the resource's current state.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

413The request body or attachments are too large.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

415The request body is not JSON.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

422The request body failed validation.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

429The organisation's request budget is spent (`too_many_requests`), or an upstream mail provider is throttling (`rate_limited`).

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

500An internal error occurred.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

502An upstream mail provider failed.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

503The service is temporarily unavailable.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

Request

curl -X PATCH "https://api.aiinbx.com/api/v2/oauth-apps/string" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "client_id": "string",
  "client_secret": "string",
  "tenant": "string",
  "pubsub_topic": "string",
  "accent": "string",
  "tagline": "string",
  "support_email": "user@example.com",
  "logo_url": "http://example.com",
  "return_urls": [
    "http://example.com"
  ]
}'

const response = await fetch("https://api.aiinbx.com/api/v2/oauth-apps/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"client_id\": \"string\",\n  \"client_secret\": \"string\",\n  \"tenant\": \"string\",\n  \"pubsub_topic\": \"string\",\n  \"accent\": \"string\",\n  \"tagline\": \"string\",\n  \"support_email\": \"user@example.com\",\n  \"logo_url\": \"http://example.com\",\n  \"return_urls\": [\n    \"http://example.com\"\n  ]\n}"
});

import requests

response = requests.patch(
    "https://api.aiinbx.com/api/v2/oauth-apps/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"client_id\": \"string\",\n  \"client_secret\": \"string\",\n  \"tenant\": \"string\",\n  \"pubsub_topic\": \"string\",\n  \"accent\": \"string\",\n  \"tagline\": \"string\",\n  \"support_email\": \"user@example.com\",\n  \"logo_url\": \"http://example.com\",\n  \"return_urls\": [\n    \"http://example.com\"\n  ]\n}",
)

Response

{
  "id": "string",
  "provider": "google",
  "name": "string",
  "slug": "string",
  "client_id": "string",
  "tenant": "string",
  "pubsub_topic": "string",
  "accent": "string",
  "tagline": "string",
  "support_email": "user@example.com",
  "logo_url": "http://example.com",
  "connect_url": "http://example.com",
  "return_urls": [
    "http://example.com"
  ],
  "redirect_uri": "http://example.com",
  "push_endpoint": "http://example.com",
  "created_at": "2019-08-24T14:15:22Z"
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}