Apps

Upsert app

Update or insert app with specified uid and type. If a matching app exists, it is updated, otherwise it is created.

put/api/apps/{uid}

Request

  • Base URL: https://docs.weavy.com (the document declares no server; this is the origin it was published from)
  • URL: https://docs.weavy.com/api/apps/{uid}
  • Auth: none declared

Path parameters

uidstring required

Unique app identifier.

Request body

typestring nullable required

Type of app (name or guid).

uidstring nullable

A string that uniquely identifies the app, for instance a product id or URL (cannot contain whitespace and must contain at least one non-digit).

namestring nullable

Display name for the app.

descriptionstring nullable

App description.

metadataobject nullable

Additional properties to associate with the app, e.g. { "color": "blue", "size": "XL" }.

picturestring nullable

An avatar picture. Can be a public URL, a base64 encoded data URI or a blob id.

tagsstring[] nullable

A list of tags to associate with the app.

access'none' | 'read' | 'write'

Default access level for users that are <em>not</em> members. Defaults to none.

  • none = only members can access the app
  • read = authenticated users can see the app and it's content but only members can contribute
  • write = authenticated users have access to the app and are allowed to create content
directorystring nullable

Id or name of a user directory. Used in combination with access to control who can access the app.

Response

OK

typestring uuid nullable

The app type.

uidstring nullable

The unique identifier for the app.

namestring nullable

Gets the name.

descriptionstring nullable

Gets the description text.

archive_urlstring nullable

Url to zip-archive with files in the app.

avatar_urlstring nullable

Gets a thumbnail image.

metadataobject nullable
tagsstring[] nullable
accessunknown
created_atstring date-time nullable

Date and time (UTC) when the app was created.

updated_atstring date-time nullable

Date and time (UTC) when the app was last updated.

is_pinnedboolean nullable

If the authenticated user has pinned this app.

is_starredboolean nullable

If the authenticated user has starred the app.

is_subscribedboolean nullable

If the authenticated user has subscribed to the app.

is_trashedboolean nullable

Is the app trashed or not.

is_unreadboolean nullable

If the authenticated user has unread messages in the app.

permissionsPermission[] nullable

Gets app permissions for the authenticated user.

Changes

No recorded changes to this operation across all 1 revision of this API.