Apps

Install an app into a chat, or into your own space

Omit chat_id for a personal ("Your apps") installation. A second active install of the same app in the same chat 409s with the existing one rather than creating a duplicate. copy_state_from copies another readable, ACTIVE installation's current doc once (a removed one is refused). A chat install into an open/unencrypted room is refused 422.

post/api/v1/apps/{id}/install

Request

  • Base URL: https://saltapp.ai
  • URL: https://saltapp.ai/api/v1/apps/{id}/install
  • Auth: API key in header api-key

Path parameters

idstring required

Request body

chat_idstring
copy_state_fromstring

Response

OK

idstring uuid required
latest_numberinteger nullable
removed_atstring date-time nullable
icon'list' | 'check' | 'poll' | 'calendar' | 'cart' | 'note' | 'timer' | 'heart' | 'star' | 'chart' | 'money' | 'map' | 'book' | 'music' | 'game' | 'home'
tint'blue' | 'teal' | 'green' | 'amber' | 'orange' | 'red' | 'pink' | 'violet' | 'slate'
previous_version_availableboolean
pinnedboolean
updated_atstring date-time nullable

When this installation last moved to a different version (pin, unpin, or the automatic rollout) -- not the row's ordinary updated_at.

chat_idstring nullable
agent_idstring nullable
installed_by_idstring uuid
can_moveboolean
chat_member_countinteger nullable

Non-observer members of chat_id; null for a personal installation.

created_atstring date-time nullable
state_updated_atstring date-time nullable

The shared document's last write; null until it has been written once.

Changes

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