Mobile and custom app API - POST a key user action

Adds a user action to the list of key user actions in the specified app.

The request consumes and produces an application/json payload.

  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/applications/mobile/{applicationId}/keyUserActions/{actionName}
  • SaaS https://{your-environment-id}{applicationId}/keyUserActions/{actionName}
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/applications/mobile/{applicationId}/keyUserActions/{actionName}


To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.


Parameter Type Description In Required
applicationId string

The ID of the required application.

path required
actionName string

The name of the user action to be marked as a key user action.

path required


Response codes

Code Description

Success. The action has been marked as a key user action. The response contains its name.


Failed. The specified entity doesn't exist.


Failed. The max number of key user actions has been reached for the application.

Response body

The KeyUserActionMobile object

A key user action.

Element Type Description
name string

The name of the key user action.