Client Apps

Update client app

Update client app details like name, description, secret etc

patch/workspaces/{workspace_id}/clientapps/{client_key}

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/workspaces/{workspace_id}/clientapps/{client_key}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Path parameters

workspace_idinteger required

Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.

Example:4
client_keystring required

Id of the client key to work with

Example:abcdefasdfafdsfaf345asf

Request body

Example request

{
  "patch": [
    {
      "op": "replace",
      "path": "app_name",
      "value": "test"
    },
    {
      "op": "replace",
      "path": "description",
      "value": "test"
    }
  ]
}

Response

Successful patch

descriptionstring nullable

Description of client app or api tokens

workspace_idinteger nullable

Workspace ID of client app or api tokens

user_idinteger nullable

User ID of client app or api tokens

last_usagestring date-time nullable

Last usage of client app or api tokens

created_atstring date-time nullable

Creation time of client app or api tokens. Null for apps created before this was recorded.

idinteger required

ID of client app or api tokens

app_namestring required

Name of client app or api tokens

app_keystring required

App key of client app or api tokens

Changes

No recorded changes to this operation across all 3 revisions of this API.