Skip to content
Connect an agent

Organisations

Change an organisation's app

Changes the name, homepage, redirect addresses, or whether only members may connect it.

PATCH/orgs/{org}/apps/{id}

TL;DR

QuestionAnswer
What does it do?Change an organisation's app.
What does it take?A JSON body of type OrgAppChangeBody.
What does it return?Status 200 with a body of type RegisteredApp.
What can go wrong?400 the body is not valid; 401 not signed in; 403 only the owner or an admin may (orgs.forbidden), or the origin may not make changes; 404 no such organisation or app; 422 a redirect address or the homepage breaks the rules (apps.invalid); 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope.

What it does

Changes the name, homepage, redirect addresses, or whether only members may connect it. The owner and an admin may.

Path parameters

FieldTypeRequiredDescription
orgstringyesThe organisation's id or its slug.
idstringyes

Request body

The body has the type OrgAppChangeBody.

FieldTypeRequiredDescription
namestringnoat least 3 characters; at most 60 characters.
homepagestring | nullnoat most 2048 characters.
redirectUrisstring[]noOne to ten addresses a code may be sent to, matched exactly: https, or http on localhost, 127.0.0.1 or [::1] with any port.
membersOnlybooleanno

Responses

StatusMeaningBody
200The app as it is now.RegisteredApp
400The body is not valid.ErrorResponse
401Not signed in.ErrorResponse
403Only the owner or an admin may (orgs.forbidden), or the origin may not make changes.ErrorResponse
404No such organisation or app.ErrorResponse
422A redirect address or the homepage breaks the rules (apps.invalid).ErrorResponse
429Too many requests.ErrorResponse
503Organisations are not set up on this server.ErrorResponse

Response body

A 200 answer has the type RegisteredApp.

FieldTypeRequiredDescription
idstringyesThe app's id, which is its OAuth client_id.
namestringyesShown to people as a claim on the consent page.
homepagestring | nullyes
clientType"confidential" | "public"yesconfidential holds a client secret on its server; public (a page or a tool with no server) holds none.
redirectUrisstring[]yes
membersOnlybooleanyesFor an organisation's app: only its members may connect it, to the organisation.
hasSecretbooleanyes
createdAtintegeryesMilliseconds since the epoch.
updatedAtintegeryesMilliseconds since the epoch.

See also

DocWhy
API referenceEvery endpoint, and the error envelope
SchemasEvery request and response type
Tool referenceThe operations as callable tools