Send app push

API endpoint to send app push.

Specify the type of app push notification to be sent through the category parameter, indicating system or trigger, respectively.


FCM / APNs must be configured before sending app push notifications. More details in the article Omnichannel Integration.

арp_push_token is considered valid if it meets one of these two conditions:

  1. The text consists of at least 64 characters in the lower case of the hexadecimal number system (0-9 and a-f) and does not contain other characters;
  2. The text has 22 characters, followed by a colon, after which it may contain any number of characters.

When using this API endpoint, the user fields listed in the table below are saved in the system and updated when using the same API endpoint in the future:

namеUser name;
genderUser gender: 'm' – male, 'f' – female;
platform_id0 – Unknown, 1 – Desktop, 2 – Mobile (Mobile Browser + Tablet), 3 – Android App, 4 – iOS App;
country_idTwo- or three-letter country code (e.g. "esp");
language_idTwo-letter language code (e.g. "es");
akAuth key - key for user authorization / autologin on the product;
ageUser age;
photoLink to the user's photo;
vipUser status: 1 – payer, 0 – non-payer.


By default, the VIP parameter has the value “0” (non-payer).

Click Try It! to start a request and see the response here!