Перейти к содержанию

API для работы с менеджерами

Добавить менеджера в проект

POST https://cloud.roistat.com/api/v1/project/integration/manager/add

Метод добавляет менеджера в проект. 

curl --location 'https://cloud.roistat.com/api/v1/project/integration/manager/add?project=НОМЕР_ПРОЕКТА' \
--header 'Api-key: свой_ключ' \
--header 'Content-Type: application/json' \
--header 'Cookie: beta_server=1' \
--data-raw '{"id": "12345", "name": "Петров", "phone": "35513222", "email": "[email protected]"}'

Тело запроса:

{
    "id": "12345",
    "name": "Петров",
    "phone": "35513222",
    "email": "[email protected]"
}

{
    "status": "success"
}

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
id string ID менеджера в CRM да
name string Имя менеджера да
phone null или string Номер телефона менеджера (должен быть указан или телефонный номер менеджера, или email) нет
email null или string Адрес электронной почты менеджера (должен быть указан или телефонный номер менеджера, или email) нет
Параметр Тип Описание
status string Статус запроса

Получить список менеджеров проекта

POST https://cloud.roistat.com/api/v1/project/integration/manager/list

Метод возвращает список менеджеров проекта. 

curl --location 'https://cloud.roistat.com/api/v1/project/integration/manager/list?project=НОМЕР_ПРОЕКТА' \
--header 'Api-key: свой_ключ' \
--header 'Cookie: beta_server=1' \
--data ''

{
    "data": [
        {
            "id": "1",
            "name": "Ivanov A",
            "email": "[email protected]",
            "phone": null
        },
        {
            "id": "12345",
            "name": "122322й1",
            "email": "[email protected]",
            "phone": "35513222"
        }],
    "total": 2,
    "status": "success"
}

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да
Параметр Тип Описание
data array[object]
> id integer ID менеджера
> name string Имя менеджера
> email string Email менеджера
> phone string Номер телефона менеджера
total integer Количество менеджеров в списке
status string Статус ответа

Обновить данные о менеджере

POST https://cloud.roistat.com/api/v1/project/integration/manager/update

Метод обновляет данные о менеджере. 

curl --location 'https://cloud.roistat.com/api/v1/project/integration/manager/update?project=НОМЕР_ПРОЕКТА' \
--header 'Api-key: свой_ключ' \
--header 'Content-Type: application/json' \
--header 'Cookie: beta_server=1' \
--data '{"id": "12345", "email": "[email protected]"}'

Тело запроса:

{
    "id": "12345",
    "email": "[email protected]"
}

{
    "status": "success"
}
Параметр Тип Описание Обязательный
id string ID менеджера в CRM да
name string Имя менеджера нет
phone null или string Номер телефона менеджера нет
email null или string Адрес электронной почты менеджера нет
Параметр Тип Описание
status string Статус запроса

Удалить менеджера из проекта

POST https://cloud.roistat.com/api/v1/project/integration/manager/delete

Метод удаляет менеджера из проекта. 

curl --location 'https://cloud.roistat.com/api/v1/project/integration/manager/delete?project=НОМЕР_ПРОЕКТА' \
--header 'Api-key: свой_ключ' \
--header 'Content-Type: application/json' \
--header 'Cookie: beta_server=1' \
--data '{ "id": "12345"}'

Тело запроса:

{
    "id": "12345"
}

{
    "status": "success"
}

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
id string ID менеджера в CRM да
Параметр Тип Описание
status string Статус запроса