App

An app is the test environment or the live environment of your TalkJS project. These endpoints let you change app metadata:

Note: getAppMetadata can be used without authentication, so don't store any sensitive data inside app custom fields.

All resource URLs below include an {appId}, which you can find on the Settings page of your TalkJS dashboard.

GETPUT/v1/{appId}

Getting app metadata

GET/v1/{appId}
type App = {
id: string;
custom?: { [name: string]: string };
defaultLocale?: string;
};

Changing app metadata

PUT/v1/{appId}
{
id?: string,
custom?: Map<string, string>,
defaultLocale?: string
}

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.