POST api/marketing/CommunicationUpdate

Изменение критериев ранее созданной рассылки по её идентификатору

Request Information

URI Parameters

None.

Body Parameters

CommunicationUpdateRequest
NameDescriptionTypeAdditional information
PosCode

Код торговой точки

string

None.

CommunicationId

Идентификатор изменяемой рассылки

integer

None.

OperatorCommunication

Идентификатор оператора, которому создают рассылку

integer

None.

PartnerSender

Признак, что отправка должна идти от имени отправителя партнера, а не оператора

boolean

None.

Name

Наименование рассылки

string

None.

CommunicationType

Тип рассылки (1 = sms; 2 = email; 3 = pushapp)

byte

None.

BegDate

Дата и время отправки рассылки

date

None.

Title

Заголовок сообщения

string

None.

TextMessage

Текст сообщения

string

None.

Image

Адрес изображения, посылаемого в сообщении

string

None.

TypeOpen

Тип экрана, который нужно открывать при нажатии на пуш (1 = акции, 2 = партнеры, 3 = уведомления, 4 = история бонусов)

string

None.

IdTypeOpen

Идентификатор партнера или акции, карточку которого нужно открыть при нажатии на пуш

string

None.

MessageTemplate

Идентификатор ранее созданного шаблона сообщения

integer

None.

MarketList

Идентификатор ранее созданного списка карт, по которым будет отправка рассылки

integer

None.

ClientList

Идентификатор ранее созданного списка клиентов, по которым будет отправка рассылки

integer

None.

Campaign

Идентификатор акции, по которой будет рассылка

integer

None.

Sample

Идентификатор выборки, на основании критериев которой необходимо создать список карт, по которым будет отправка рассылки

integer

None.

BonusListRule

Идентификатор правила начисления бонусов на список клиентов

integer

None.

Operator

Идентификатор оператора программы лояльности

integer

None.

Token

Токен пользователя, который инициирует данный запрос

integer

None.

SiteCode

Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос

string

None.

Request Formats

application/json, text/json

Sample:
{
  "PosCode": "sample string 1",
  "CommunicationId": 1,
  "OperatorCommunication": 1,
  "PartnerSender": true,
  "Name": "sample string 2",
  "CommunicationType": 64,
  "BegDate": "2022-08-14T15:13:33.6325067+03:00",
  "Title": "sample string 3",
  "TextMessage": "sample string 4",
  "Image": "sample string 5",
  "TypeOpen": "sample string 6",
  "IdTypeOpen": "sample string 7",
  "MessageTemplate": 1,
  "MarketList": 1,
  "ClientList": 1,
  "Campaign": 1,
  "Sample": 1,
  "BonusListRule": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 8"
}

application/xml, text/xml

Sample:
<CommunicationUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.MarketingRequest">
  <Operator xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Operator>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 8</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <BegDate>2022-08-14T15:13:33.6325067+03:00</BegDate>
  <BonusListRule>1</BonusListRule>
  <Campaign>1</Campaign>
  <ClientList>1</ClientList>
  <CommunicationId>1</CommunicationId>
  <CommunicationType>64</CommunicationType>
  <IdTypeOpen>sample string 7</IdTypeOpen>
  <Image>sample string 5</Image>
  <MarketList>1</MarketList>
  <MessageTemplate>1</MessageTemplate>
  <Name>sample string 2</Name>
  <OperatorCommunication>1</OperatorCommunication>
  <PartnerSender>true</PartnerSender>
  <PosCode>sample string 1</PosCode>
  <Sample>1</Sample>
  <TextMessage>sample string 4</TextMessage>
  <Title>sample string 3</Title>
  <TypeOpen>sample string 6</TypeOpen>
</CommunicationUpdateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CommunicationUpdateResponse
NameDescriptionTypeAdditional information
ErrorCode

Код ошибки

integer

None.

Message

Сообщение об ошибке

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<CommunicationUpdateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.MarketingResponse">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 2</Message>
</CommunicationUpdateResponse>