App metadata

Update app metadata

Use this endpoint to update metadata for your app. Metadata include the app's ID, its default locale, and any custom properties.

You can't update the app ID itself. If given, the id must correspond to the appId path parameter.

put/v1/{appId}

Request

Base URL
https://api.talkjs.com
Auth
- HTTP bearer
- or HTTP bearer
TypeScript
https://skmtc.dev/talkjs/apis/talkjs-api/docs/v1/:appId/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

appIdstring required

Example:abcd1234

A unique identifier of your TalkJS app. You can find your app ID on the Settings page of your dashboard.

Request body

idstring

A unique identifier of your TalkJS app. You can find your app ID on the Settings page of your dashboard.

customobject nullable

Global custom fields for the entire app. Custom fields can be used in themes and notification settings. For more on custom fields, see: Custom fields.

An IETF language tag for the app's default locale, for localization purposes. The default locale must be one of the supported languages. You can override the default locale for each user.

Example request

{
  "id": "abcd1234",
  "custom": {
    "website": "https://www.example.com"
  },
  "defaultLocale": "ar"
}

Response

Empty response

object required