App
An app is the test environment or the live environment of your TalkJS project. These endpoints let you change app metadata:
- custom: global custom fields for the entire app. Can be used in themes and
notification settings as
{{ app.custom.fieldName }}
. - defaultLocale: An IETF language tag for the app's default locale. Must be one of the supported languages. You can override this locale for each user.
All resource URLs below include an {appId}
, which you can find on the Settings page of your TalkJS dashboard.
GETPUT/v1/{appId}
GET/v1/{appId}
Response Structure
Example Response
1type App = {2 id: string;3 custom?: { [name: string]: string };4 defaultLocale?: string;5};
1{2 "custom": {},3 "defaultLocale": "en-US",4 "id": "123456789"5}
PUT/v1/{appId}
Payload Structure
Example Payload
1{2 id?: string,3 custom?: Map<string, string>,4 defaultLocale?: string5}
1{2 "custom": {"some": "data"},3 "defaultLocale": "en-US",4}
All the parameters in the payload are optional.
Note that id
can't be changed. If given, the id
must correspond to the appId
found in the URL.