Change an application's settings

PATCH

/v1/apps/{app}

curl --request PATCH \
  --url https://api.eu.apigami.com/v1/apps/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "visibility": "private", "redirect_uris": [ "https://example.com" ], "avatar_file_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

• Production, EU (Frankfurt)

Its name, visibility, logo or redirect URIs. What the code declares changes only with a version. PUT is accepted too. Deleting an application is a gesture of the dashboard only.

Authorizations

• personalAccessToken
• agentToken

Parameters

Path Parameters

app

required

string format: uuid

Request Body^required

Media typeapplication/json

object

name

string

>= 1 characters <= 200 characters

visibility

string

Allowed values: private unlisted public

redirect_uris

Array<string>

<= 100 items

avatar_file_id

string | null format: uuid

Responses

200

The application as it now stands.

Media typeapplication/json

object

id

required

The app_id.

string format: uuid

group_id

required

string format: uuid

name

required

string

redirect_uris

required

Array<string>

avatar_file_id

required

string | null format: uuid

visibility

required

string

Allowed values: private unlisted public

verified_at

required

string | null format: date-time

created_at

required

string format: date-time

Example

{
  "visibility": "private"
}

404

Not an application of your team.

Media typeapplication/json

object

error

required

string

consentPending

Present and true when the approval window is open and the user has not answered within 45 s.

boolean

Example

{
  "error": "not found"
}