Update promotion script

POST/api/crm/v2/mobile_apps_promoter_script.updatev2

operationId: mobileAppsPromoterScript.update

Updates the promotion script. If reset_screenshot=true, the app screenshot will be recreated.

Authorization

api-token + language + role

Query parameters

chain_idintegerrequired

Example: 7160

Request body `application/json`

object

main_frame_text_headerstring

Example: We have a mobile application

main_frame_text_bodystring

Example: Install it and get a bonus

main_frame_background_imagestringrequired

Example: https://cdn.foodsoul.test/backgrounds/promoter_script/1312e71798302424c25c538639989665.jpg

main_frame_background_colorstringrequired

Example: 7E57C2

main_frame_background_dotsboolean

Example: true

main_frame_colors_buttonsstringrequired

Example: 0D47A1

main_frame_colors_textstringrequired

Example: FFFFFF

main_frame_colors_iphonestring (MainFrameColorsIphone) required

Values:space_graysilvergold

Example: gold

reset_screenshotboolean

Create a new app screenshot

Example: true

button_positionstring (ButtonPosition) required

Values:top_righttop_leftbottom_rightbottom_left

Example: top_right

button_orientationstring (ButtonOrientation) required

Values:horizontallyvertically

Example: horizontally

button_text_first_linestring

Example: Download our

button_text_second_linestring

Example: application

button_offset_xintegerrequired

Example: 24

button_offset_yintegerrequired

Example: 24

button_colors_backgroundstringrequired

Example: 651FFF

button_colors_textstringrequired

Example: FFFFFF

small_sizeboolean

Example: true

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

curl -X POST 'https://foodsoul.pro/api/crm/v2/mobile_apps_promoter_script.update?chain_id=7160' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: en' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"main_frame_text_header":"We have a mobile application","main_frame_text_body":"Install it and get a bonus","main_frame_background_image":"https://cdn.foodsoul.test/backgrounds/promoter_script/1312e71798302424c25c538639989665.jpg","main_frame_background_color":"7E57C2","main_frame_background_dots":true,"main_frame_colors_buttons":"0D47A1","main_frame_colors_text":"FFFFFF","main_frame_colors_iphone":"gold","reset_screenshot":true,"button_position":"top_right","button_orientation":"horizontally","button_text_first_line":"Download our","button_text_second_line":"application","button_offset_x":24,"button_offset_y":24,"button_colors_background":"651FFF","button_colors_text":"FFFFFF","small_size":true}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/mobile_apps_promoter_script.update?chain_id=7160', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'en',
        'role' => 'partner',
    ],
    'json' => [
        'main_frame_text_header' => 'We have a mobile application',
        'main_frame_text_body' => 'Install it and get a bonus',
        'main_frame_background_image' => 'https://cdn.foodsoul.test/backgrounds/promoter_script/1312e71798302424c25c538639989665.jpg',
        'main_frame_background_color' => '7E57C2',
        'main_frame_background_dots' => true,
        'main_frame_colors_buttons' => '0D47A1',
        'main_frame_colors_text' => 'FFFFFF',
        'main_frame_colors_iphone' => 'gold',
        'reset_screenshot' => true,
        'button_position' => 'top_right',
        'button_orientation' => 'horizontally',
        'button_text_first_line' => 'Download our',
        'button_text_second_line' => 'application',
        'button_offset_x' => 24,
        'button_offset_y' => 24,
        'button_colors_background' => '651FFF',
        'button_colors_text' => 'FFFFFF',
        'small_size' => true,
    ],
]);

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/mobile_apps_promoter_script.update?chain_id=7160", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "main_frame_text_header": "We have a mobile application",
        "main_frame_text_body": "Install it and get a bonus",
        "main_frame_background_image": "https://cdn.foodsoul.test/backgrounds/promoter_script/1312e71798302424c25c538639989665.jpg",
        "main_frame_background_color": "7E57C2",
        "main_frame_background_dots": true,
        "main_frame_colors_buttons": "0D47A1",
        "main_frame_colors_text": "FFFFFF",
        "main_frame_colors_iphone": "gold",
        "reset_screenshot": true,
        "button_position": "top_right",
        "button_orientation": "horizontally",
        "button_text_first_line": "Download our",
        "button_text_second_line": "application",
        "button_offset_x": 24,
        "button_offset_y": 24,
        "button_colors_background": "651FFF",
        "button_colors_text": "FFFFFF",
        "small_size": true
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/mobile_apps_promoter_script.update?chain_id=7160",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
    },
    json={
        "main_frame_text_header": "We have a mobile application",
        "main_frame_text_body": "Install it and get a bonus",
        "main_frame_background_image": "https://cdn.foodsoul.test/backgrounds/promoter_script/1312e71798302424c25c538639989665.jpg",
        "main_frame_background_color": "7E57C2",
        "main_frame_background_dots": True,
        "main_frame_colors_buttons": "0D47A1",
        "main_frame_colors_text": "FFFFFF",
        "main_frame_colors_iphone": "gold",
        "reset_screenshot": True,
        "button_position": "top_right",
        "button_orientation": "horizontally",
        "button_text_first_line": "Download our",
        "button_text_second_line": "application",
        "button_offset_x": 24,
        "button_offset_y": 24,
        "button_colors_background": "651FFF",
        "button_colors_text": "FFFFFF",
        "small_size": True,
    },
)
data = response.json()

Response 200

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

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

Update promotion script

Authorization

Query parameters

Request body application/json

Responses

Request body `application/json`