POST api/lead/LeadCreate
Создание лида
Request Information
URI Parameters
None.
Body Parameters
LeadCreateRequestName | Description | Type | Additional information |
---|---|---|---|
Partner |
Идентификатор парнера |
integer |
None. |
Poscode |
Код торговой точки |
string |
None. |
Client |
Идентификатор клиента из таблицы client |
integer |
None. |
Type |
Идентификатор типа лида из таблицы leadtype |
integer |
None. |
Formname |
Наименование формы, из которой создаётся лид |
string |
None. |
Leadname |
ФИО лида |
string |
None. |
Phone |
Телефон лида |
integer |
None. |
E-mail лида |
string |
None. |
|
Cheque |
Идентификатор чека, на который ссылается лид |
integer |
None. |
Goods |
Идентификатор товара, на который ссылается лид |
integer |
None. |
Pos |
Идентификатор точки, на который ссылается лид |
integer |
None. |
Leadmark |
Оценка, которую поставил лид, отправляя сообщение |
integer |
None. |
Direction |
Направление (продукт) по которому создаётся лид (1 = Лояльность, 2 = Сертификаты, 3 = CRM) |
byte |
None. |
SertCardOwner |
Идентификатор владельца или друга владельца сертификатов |
integer |
None. |
Person |
Идентификатор человека (контакта) |
integer |
None. |
BotId |
Идентификатор бота, который создаёт лид |
string |
None. |
CustomerBot |
Идентификатор пользователя в мессенджере/социальной сети |
string |
None. |
OrderBasket |
Идентификатор заказа клиента, на который ссылается лид |
integer |
None. |
OrderInvoices |
Идентификатор накладной заказа клиента, на который ссылается лид |
integer |
None. |
Comment |
Произвольно задаваемый текст из формы |
string |
None. |
Leadmessage |
Данные о сообщениях лида |
LeadMessage |
None. |
LeadFieldData |
Данные о лиде |
Collection of LeadFieldDataStr |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{ "Partner": 1, "Poscode": "sample string 2", "Client": 1, "Type": 3, "Formname": "sample string 4", "Leadname": "sample string 5", "Phone": 1, "Email": "sample string 6", "Cheque": 1, "Goods": 1, "Pos": 1, "Leadmark": 1, "Direction": 64, "SertCardOwner": 1, "Person": 1, "BotId": "sample string 7", "CustomerBot": "sample string 8", "OrderBasket": 1, "OrderInvoices": 1, "Comment": "sample string 9", "Leadmessage": { "Subject": "sample string 1", "Leadtext": "sample string 2", "Image": "sample string 3", "File": "sample string 4" }, "LeadFieldData": [ { "Id": 1, "Field": "sample string 1", "Value": "sample string 2", "Type": "sample string 3", "TypeId": "sample string 4" }, { "Id": 1, "Field": "sample string 1", "Value": "sample string 2", "Type": "sample string 3", "TypeId": "sample string 4" } ], "Operator": 1, "Token": 1, "SiteCode": "sample string 10" }
application/xml, text/xml
<LeadCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request"> <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 10</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <BotId>sample string 7</BotId> <Cheque>1</Cheque> <Client>1</Client> <Comment>sample string 9</Comment> <CustomerBot>sample string 8</CustomerBot> <Direction>64</Direction> <Email>sample string 6</Email> <Formname>sample string 4</Formname> <Goods>1</Goods> <LeadFieldData xmlns:d2p1="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Data"> <d2p1:LeadFieldDataStr> <d2p1:Field>sample string 1</d2p1:Field> <d2p1:Id>1</d2p1:Id> <d2p1:Type>sample string 3</d2p1:Type> <d2p1:TypeId>sample string 4</d2p1:TypeId> <d2p1:Value>sample string 2</d2p1:Value> </d2p1:LeadFieldDataStr> <d2p1:LeadFieldDataStr> <d2p1:Field>sample string 1</d2p1:Field> <d2p1:Id>1</d2p1:Id> <d2p1:Type>sample string 3</d2p1:Type> <d2p1:TypeId>sample string 4</d2p1:TypeId> <d2p1:Value>sample string 2</d2p1:Value> </d2p1:LeadFieldDataStr> </LeadFieldData> <Leadmark>1</Leadmark> <Leadmessage xmlns:d2p1="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Data"> <d2p1:File>sample string 4</d2p1:File> <d2p1:Image>sample string 3</d2p1:Image> <d2p1:Leadtext>sample string 2</d2p1:Leadtext> <d2p1:Subject>sample string 1</d2p1:Subject> </Leadmessage> <Leadname>sample string 5</Leadname> <OrderBasket>1</OrderBasket> <OrderInvoices>1</OrderInvoices> <Partner>1</Partner> <Person>1</Person> <Phone>1</Phone> <Pos>1</Pos> <Poscode>sample string 2</Poscode> <SertCardOwner>1</SertCardOwner> <Type>3</Type> </LeadCreateRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
LeadCreateResponseName | Description | Type | Additional information |
---|---|---|---|
Client |
Идентификатор клиента, если лид по участнику программы лояльности |
integer |
None. |
Leads |
Идентификатор лида |
integer |
None. |
Leaddata |
Идентификатор лида в таблице leaddata |
integer |
None. |
Leadmessage |
Идентификатор лида в таблице leadmessage |
integer |
None. |
Tiket |
Идентификатор тикета, в рамках которого создано сообщение лида |
integer |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "Client": 1, "Leads": 2, "Leaddata": 3, "Leadmessage": 4, "Tiket": 1, "ErrorCode": 5, "Message": "sample string 6" }
application/xml, text/xml
<LeadCreateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response"> <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">5</ErrorCode> <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 6</Message> <Client>1</Client> <Leaddata>3</Leaddata> <Leadmessage>4</Leadmessage> <Leads>2</Leads> <Tiket>1</Tiket> </LeadCreateResponse>