API

Accrue or deduct bonuses

POST/api/crm/v2/clients_bonuses.addv2
operationId: clientsBonuses.add

Performs manual bonus accrual (type=accrual) or withdrawal (type=withdraw):

  • With mode=one, applies to a single client identified by phone_format_id and phone_number.
  • With mode=all, applies to all clients in the network, optionally filtered by gender.
    Dates are converted to UTC based on the sales point's time zone.
    Unavailable while system automation is enabled; the client must have bonuses enabled.
    Bulk accrual returns not_accrualed_for_phones — phone numbers for which the operation failed.

Authorization

api-token + language + role

Request body application/json

object
modestringrequired

Values:oneall

typestringrequired

Values:accrualwithdraw

chain_idintegerrequired

Example: 7124

date_availablestring (DataTimeFormat)

Example: 17:45 06/05/2024

date_expirationstring (DataTimeFormat)

Example: 17:45 06/05/2024

descriptionstring

For type=accrual

sumnumberrequired

Example: 125.5

phone_format_idinteger (PhoneFormatId)

Country code: 1-🇷🇺(+7|8), 2-🇦🇿(+994|0), 3-🇧🇾(+375|80), 4-🇰🇿(+7|8), 6-🇷🇸(+381|0), 7-🇹🇷(+90|0), 8-🇺🇦(+380|0), 9-🇵🇹(+351|0), 10-🇰🇬(+996|0), 11-🇺🇸(+1), 12-🇫🇷(+33|0), 13-🇲🇩(+373|0), 15-🇪🇪(+372), 18-🇬🇪(+995), 19-🇺🇿(+998), 22-🇵🇱(+48|0), 23-🇹🇯(+992|8), 25-🇷🇴(+40|0), 44-🇨🇭(+41|0)

Example: 1

phone_numberstring

For mode=one

Example: 999-999-99-99

genderstring

For mode=all

Values:manwoman

Responses

OK

object
statusstringrequired

Values:successerror

Example: success

dataobject