updateApp

PUT

/v5/apps

Update an app

Request Body

object

apiVersion

The API version of the event payload

string

Allowed values: v0 v1 v2 v3 v4 v5

clientId

The Google OAuth Client ID

string

clientSecret

The Google OAuth Client Secret

string

connectable

Whether this app is connectable by a user

boolean

deprecated

Whether the app is deprecated

boolean

description

The App description

string

developers

The developers (usernames and domain patterns), comma or space separated

string

events

Event types the App listen to

Array<string>

Allowed values: FILE_CREATED FILE_UPDATED TRANSACTION_CREATED TRANSACTION_UPDATED TRANSACTION_DELETED TRANSACTION_POSTED TRANSACTION_CHECKED TRANSACTION_UNCHECKED TRANSACTION_RESTORED ACCOUNT_CREATED ACCOUNT_UPDATED ACCOUNT_DELETED QUERY_CREATED QUERY_UPDATED QUERY_DELETED GROUP_CREATED GROUP_UPDATED GROUP_DELETED COMMENT_CREATED COMMENT_DELETED COLLABORATOR_ADDED COLLABORATOR_UPDATED COLLABORATOR_REMOVED INTEGRATION_CREATED INTEGRATION_UPDATED INTEGRATION_DELETED BOOK_CREATED BOOK_AUDITED BOOK_UPDATED BOOK_DELETED

filePatterns

File patterns the App handles - wildcard accepted. E.g. *.pdf, *-bank.csv

Array<string>

id

The unique agent id of the App - this can’t be changed after created

string

installable

Whether this app is installable in a book

boolean

logoUrl

The App logo url

string

logoUrlDark

The App logo url in dark mode

string

menuPopupHeight

The menu popup window height

string

menuPopupWidth

The menu popup window width

string

menuText

The contex menu text - default to the App name

string

menuUrl

The context menu url

string

menuUrlDev

The context menu url in dev mode

string

name

The App name

string

ownerEmail

The owner user email

string

ownerId

The owner user id

string

ownerLogoUrl

The owner company logo url

string

ownerName

The owner company name

string

ownerWebsite

The owner company website url

string

propertiesSchema

object

account

object

keys

The property keys schema

Array<string>

values

The property values schema

Array<string>

Example

{
  "keys": [
    "string"
  ],
  "values": [
    "string"
  ]
}

book

object

keys

The property keys schema

Array<string>

values

The property values schema

Array<string>

Example

{
  "keys": [
    "string"
  ],
  "values": [
    "string"
  ]
}

group

object

keys

The property keys schema

Array<string>

values

The property values schema

Array<string>

Example

{
  "keys": [
    "string"
  ],
  "values": [
    "string"
  ]
}

transaction

object

keys

The property keys schema

Array<string>

values

The property values schema

Array<string>

Example

{
  "keys": [
    "string"
  ],
  "values": [
    "string"
  ]
}

Example

{
  "account": {
    "keys": [
      "string"
    ],
    "values": [
      "string"
    ]
  },
  "book": {
    "keys": [
      "string"
    ],
    "values": [
      "string"
    ]
  },
  "group": {
    "keys": [
      "string"
    ],
    "values": [
      "string"
    ]
  },
  "transaction": {
    "keys": [
      "string"
    ],
    "values": [
      "string"
    ]
  }
}

published

Whether this app is already published

boolean

readme

The readme.md file as string

string

readmeMd

The readme.md file as raw markdown string

string

repoPrivate

Whether the code repository is private

boolean

repoUrl

The code repository url

string

scopes

The Google OAuth Scopes used by the app

Array<string>

users

The users (usernames and domain patterns) to enable the App while not yet published

string

webhookUrl

The Webhook endpoint URL to listen for book events

string

webhookUrlDev

The Webhook endpoint URL to listen for book events in dev mode

string

website

The App website url

string

Example

{
  "apiVersion": "v0",
  "clientId": "string",
  "clientSecret": "string",
  "connectable": true,
  "deprecated": true,
  "description": "string",
  "developers": "string",
  "events": [
    "FILE_CREATED"
  ],
  "filePatterns": [
    "string"
  ],
  "id": "string",
  "installable": true,
  "logoUrl": "string",
  "logoUrlDark": "string",
  "menuPopupHeight": "string",
  "menuPopupWidth": "string",
  "menuText": "string",
  "menuUrl": "string",
  "menuUrlDev": "string",
  "name": "string",
  "ownerEmail": "string",
  "ownerId": "string",
  "ownerLogoUrl": "string",
  "ownerName": "string",
  "ownerWebsite": "string",
  "propertiesSchema": {
    "account": {
      "keys": [
        "string"
      ],
      "values": [
        "string"
      ]
    },
    "book": {
      "keys": [
        "string"
      ],
      "values": [
        "string"
      ]
    },
    "group": {
      "keys": [
        "string"
      ],
      "values": [
        "string"
      ]
    },
    "transaction": {
      "keys": [
        "string"
      ],
      "values": [
        "string"
      ]
    }
  },
  "published": true,
  "readme": "string",
  "readmeMd": "string",
  "repoPrivate": true,
  "repoUrl": "string",
  "scopes": [
    "string"
  ],
  "users": "string",
  "webhookUrl": "string",
  "webhookUrlDev": "string",
  "website": "string"
}

Responses

200

A App response

object

apiVersion

The API version of the event payload

string

Allowed values: v0 v1 v2 v3 v4 v5

clientId

The Google OAuth Client ID

string

clientSecret

The Google OAuth Client Secret

string

connectable

Whether this app is connectable by a user

boolean

deprecated

Whether the app is deprecated

boolean

description

The App description

string

developers

The developers (usernames and domain patterns), comma or space separated

string

events

Event types the App listen to

Array<string>

Allowed values: FILE_CREATED FILE_UPDATED TRANSACTION_CREATED TRANSACTION_UPDATED TRANSACTION_DELETED TRANSACTION_POSTED TRANSACTION_CHECKED TRANSACTION_UNCHECKED TRANSACTION_RESTORED ACCOUNT_CREATED ACCOUNT_UPDATED ACCOUNT_DELETED QUERY_CREATED QUERY_UPDATED QUERY_DELETED GROUP_CREATED GROUP_UPDATED GROUP_DELETED COMMENT_CREATED COMMENT_DELETED COLLABORATOR_ADDED COLLABORATOR_UPDATED COLLABORATOR_REMOVED INTEGRATION_CREATED INTEGRATION_UPDATED INTEGRATION_DELETED BOOK_CREATED BOOK_AUDITED BOOK_UPDATED BOOK_DELETED

filePatterns

File patterns the App handles - wildcard accepted. E.g. *.pdf, *-bank.csv

Array<string>

id

The unique agent id of the App - this can’t be changed after created

string

installable

Whether this app is installable in a book

boolean

logoUrl

The App logo url

string

logoUrlDark

The App logo url in dark mode

string

menuPopupHeight

The menu popup window height

string

menuPopupWidth

The menu popup window width

string

menuText

The contex menu text - default to the App name

string

menuUrl

The context menu url

string

menuUrlDev

The context menu url in dev mode

string

name

The App name

string

ownerEmail

The owner user email

string

ownerId

The owner user id

string

ownerLogoUrl

The owner company logo url

string

ownerName

The owner company name

string

ownerWebsite

The owner company website url

string

propertiesSchema

object

account

object

keys

The property keys schema

Array<string>

values

The property values schema

Array<string>

Example

{
  "keys": [
    "string"
  ],
  "values": [
    "string"
  ]
}

book

object

keys

The property keys schema

Array<string>

values

The property values schema

Array<string>

Example

{
  "keys": [
    "string"
  ],
  "values": [
    "string"
  ]
}

group

object

keys

The property keys schema

Array<string>

values

The property values schema

Array<string>

Example

{
  "keys": [
    "string"
  ],
  "values": [
    "string"
  ]
}

transaction

object

keys

The property keys schema

Array<string>

values

The property values schema

Array<string>

Example

{
  "keys": [
    "string"
  ],
  "values": [
    "string"
  ]
}

Example

{
  "account": {
    "keys": [
      "string"
    ],
    "values": [
      "string"
    ]
  },
  "book": {
    "keys": [
      "string"
    ],
    "values": [
      "string"
    ]
  },
  "group": {
    "keys": [
      "string"
    ],
    "values": [
      "string"
    ]
  },
  "transaction": {
    "keys": [
      "string"
    ],
    "values": [
      "string"
    ]
  }
}

published

Whether this app is already published

boolean

readme

The readme.md file as string

string

readmeMd

The readme.md file as raw markdown string

string

repoPrivate

Whether the code repository is private

boolean

repoUrl

The code repository url

string

scopes

The Google OAuth Scopes used by the app

Array<string>

users

The users (usernames and domain patterns) to enable the App while not yet published

string

webhookUrl

The Webhook endpoint URL to listen for book events

string

webhookUrlDev

The Webhook endpoint URL to listen for book events in dev mode

string

website

The App website url

string

Example

{
  "apiVersion": "v0",
  "clientId": "string",
  "clientSecret": "string",
  "connectable": true,
  "deprecated": true,
  "description": "string",
  "developers": "string",
  "events": [
    "FILE_CREATED"
  ],
  "filePatterns": [
    "string"
  ],
  "id": "string",
  "installable": true,
  "logoUrl": "string",
  "logoUrlDark": "string",
  "menuPopupHeight": "string",
  "menuPopupWidth": "string",
  "menuText": "string",
  "menuUrl": "string",
  "menuUrlDev": "string",
  "name": "string",
  "ownerEmail": "string",
  "ownerId": "string",
  "ownerLogoUrl": "string",
  "ownerName": "string",
  "ownerWebsite": "string",
  "propertiesSchema": {
    "account": {
      "keys": [
        "string"
      ],
      "values": [
        "string"
      ]
    },
    "book": {
      "keys": [
        "string"
      ],
      "values": [
        "string"
      ]
    },
    "group": {
      "keys": [
        "string"
      ],
      "values": [
        "string"
      ]
    },
    "transaction": {
      "keys": [
        "string"
      ],
      "values": [
        "string"
      ]
    }
  },
  "published": true,
  "readme": "string",
  "readmeMd": "string",
  "repoPrivate": true,
  "repoUrl": "string",
  "scopes": [
    "string"
  ],
  "users": "string",
  "webhookUrl": "string",
  "webhookUrlDev": "string",
  "website": "string"
}