Refresh Access Token

curl --request POST \
  --url https://oauth2-{dc}.moengage.com/v1/oauth/refresh \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data grant_type=refresh_token \
  --data client_id=YOUR_WORKSPACE_ID \
  --data refresh_token=550e8400-e29b-41d4-a716-446655440000

{
  "status": "SUCCESS",
  "data": {
    "access_token": "eyJhbGciOiJSUzI1NiJ9.<new-payload>.<new-signature>",
    "token_type": "Bearer",
    "expires_in": 900
  }
}

{
  "status": "FAILURE",
  "error_type": "ER021",
  "reason": "refresh_token is required."
}

{
  "status": "FAILURE",
  "error_type": "ER010",
  "reason": "Refresh token is not valid."
}

{
  "status": "FAILURE",
  "error_type": "<string>",
  "reason": "<string>"
}

{
  "status": "FAILURE",
  "error_type": "RATE_LIMIT_EXCEEDED",
  "reason": "Too many requests."
}

Refresh Access Token

Exchange a refresh token for a new access token. The refresh request does not use your API key.

A refresh returns a new access token and preserves your existing refresh token. Continue using that refresh token until the token reaches its 30-day expiry, and then call Generate Access Token again with your client_id and client_secret.

For the end-to-end integration, refer to OAuth 2.0 Overview. For the recommended refresh timing, refer to Recommended Practices.

POST

oauth

refresh

Refresh Access Token

curl --request POST \
  --url https://oauth2-{dc}.moengage.com/v1/oauth/refresh \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data grant_type=refresh_token \
  --data client_id=YOUR_WORKSPACE_ID \
  --data refresh_token=550e8400-e29b-41d4-a716-446655440000

{
  "status": "SUCCESS",
  "data": {
    "access_token": "eyJhbGciOiJSUzI1NiJ9.<new-payload>.<new-signature>",
    "token_type": "Bearer",
    "expires_in": 900
  }
}

{
  "status": "FAILURE",
  "error_type": "ER021",
  "reason": "refresh_token is required."
}

{
  "status": "FAILURE",
  "error_type": "ER010",
  "reason": "Refresh token is not valid."
}

{
  "status": "FAILURE",
  "error_type": "<string>",
  "reason": "<string>"
}

{
  "status": "FAILURE",
  "error_type": "RATE_LIMIT_EXCEEDED",
  "reason": "Too many requests."
}

Body

application/x-www-form-urlencoded

The form-encoded parameters for the refresh token grant.

grant_type

enum<string>

required

The OAuth 2.0 grant type. The supported value is refresh_token.

Available options:

refresh_token

client_id

string

required

Your Workspace ID. The value must match the Workspace ID that the refresh token was issued to, or the request fails with ER013.

refresh_token

string

required

The refresh token returned by Generate Access Token. The refresh token is valid for 30 days.

Response

MoEngage issued a new access token. The refresh token sent in the request remains valid until the token reaches its 30-day expiry.

status

string

The status of the request. The value is SUCCESS for a successful request.

Example:

"SUCCESS"

data

object

Show child attributes