GUgupshup
Universal App Token

Mint Universal App Token (UAT)

Issues a new Universal App Token scoped to a single app.

post/partner/app/{appId}/token

Request

  • Base URL
    https://partner.gupshup.io
  • URL
    https://partner.gupshup.io/partner/app/{appId}/token
  • Auth
    API key in header Authorization

Path parameters

appIdstring uuid required
Example:6f2c9e1a-1b2c-3d4e-5f60-7a8b9c0d1e2f

App ID. Must be linked to the caller's partner.

Request body application/x-www-form-urlencoded

namestring required

Token label. 1 to 128 chars. Unique among this app's currently active UATs.

expiryinteger

Absolute expiry in epoch milliseconds. Omit for the 24h default. If set, must satisfy now + 1h <= expiry <= now + 24h.

Example request

{
  "name": "webhook-service",
  "expiry": 1783075200000
}

Response

Successful response. Raw JWT returned once.

statusstring
tokenstring

The raw UAT JWT. Returned only once, at mint time.

idstring

Token row id, usable with the list and revoke APIs.

Example response

{
  "status": "success",
  "token": "eyJhbGciOiJSUzI1NiJ9...",
  "id": "6f2c9e1a-..."
}

Changes

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