Add push notification

POST/api/crm/v2/push_notifications.addv2

operationId: pushNotifications.add

Creates a push notification. The audience is filtered by gender, birth date range, and last order date range. The sending time is set in date_sending; if omitted, the notification is sent immediately. A network can create no more than 3 notifications per day with the same set of filters.

Authorization

api-token + language + role

Request body `application/json`

object

branch_idoneOfrequired

Example: 8793

One of the options

integer

genderstring (Gender)

Values:womanman

Example: man

platformstring (Platform) required

Values:androidiosallmobile_appssitesocial_apps

Example: all

titlestringrequired

Example: test_push

messagestringrequired

Example: my message

date_sendingstring

Example: 10:41 09/07/2024

date_of_birth_fromstring

Example: 09/07

date_of_birth_tostring

Example: 10/07

date_last_order_fromstring

Example: 09/07/2024

date_last_order_tostring

Example: 10/07/2024

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

curl -X POST 'https://foodsoul.pro/api/crm/v2/push_notifications.add' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: en' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"branch_id":8793,"gender":"man","platform":"all","title":"test_push","message":"my message","date_sending":"10:41 09/07/2024","date_of_birth_from":"09/07","date_of_birth_to":"10/07","date_last_order_from":"09/07/2024","date_last_order_to":"10/07/2024"}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/push_notifications.add', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'en',
        'role' => 'partner',
    ],
    'json' => [
        'branch_id' => 8793,
        'gender' => 'man',
        'platform' => 'all',
        'title' => 'test_push',
        'message' => 'my message',
        'date_sending' => '10:41 09/07/2024',
        'date_of_birth_from' => '09/07',
        'date_of_birth_to' => '10/07',
        'date_last_order_from' => '09/07/2024',
        'date_last_order_to' => '10/07/2024',
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/push_notifications.add", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "branch_id": 8793,
        "gender": "man",
        "platform": "all",
        "title": "test_push",
        "message": "my message",
        "date_sending": "10:41 09/07/2024",
        "date_of_birth_from": "09/07",
        "date_of_birth_to": "10/07",
        "date_last_order_from": "09/07/2024",
        "date_last_order_to": "10/07/2024"
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/push_notifications.add",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
    },
    json={
        "branch_id": 8793,
        "gender": "man",
        "platform": "all",
        "title": "test_push",
        "message": "my message",
        "date_sending": "10:41 09/07/2024",
        "date_of_birth_from": "09/07",
        "date_of_birth_to": "10/07",
        "date_last_order_from": "09/07/2024",
        "date_last_order_to": "10/07/2024",
    },
)
data = response.json()

Response 200

{
  "status": "success",
  "data": {}
}

Requests are sent to foodsoul.pro — the host of this portal; you cannot choose another one.

Add push notification

Authorization

Request body application/json

Responses

Request body `application/json`