POST api/AddContactsBySegment

Request Information

URI Parameters

None.

Body Parameters

SegmentContactPostVm
NameDescriptionTypeAdditional information
SegmentId

integer

None.

SegmentContacts

Collection of SegmentContactVm

None.

ContactsIds

Collection of integer

None.

Type

string

None.

UserId

integer

None.

LeadSourceId

integer

None.

LeadStageId

integer

None.

ProjectId

integer

None.

PageNumber

integer

None.

PageSize

integer

None.

ContactSourceId

integer

None.

ContactCategoryId

integer

None.

ContactStageId

integer

None.

AssignedToIds

string

None.

Request Formats

application/json, text/json

Sample:
{
  "SegmentId": 1,
  "SegmentContacts": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "ContactCC": "sample string 3",
      "Contact": "sample string 4",
      "Email": "sample string 5",
      "IsMobileVerified": true,
      "IsEmailVerified": true,
      "IsMobile": true,
      "IsEmail": true,
      "SegmentId": 1
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "ContactCC": "sample string 3",
      "Contact": "sample string 4",
      "Email": "sample string 5",
      "IsMobileVerified": true,
      "IsEmailVerified": true,
      "IsMobile": true,
      "IsEmail": true,
      "SegmentId": 1
    }
  ],
  "ContactsIds": [
    1,
    2
  ],
  "Type": "sample string 2",
  "UserId": 3,
  "LeadSourceId": 4,
  "LeadStageId": 5,
  "ProjectId": 6,
  "PageNumber": 7,
  "PageSize": 8,
  "ContactSourceId": 9,
  "ContactCategoryId": 10,
  "ContactStageId": 11,
  "AssignedToIds": "sample string 12"
}

application/xml, text/xml

Sample:
<SegmentContactPostVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Services.Campaign">
  <AssignedToIds>sample string 12</AssignedToIds>
  <ContactCategoryId>10</ContactCategoryId>
  <ContactSourceId>9</ContactSourceId>
  <ContactStageId>11</ContactStageId>
  <ContactsIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </ContactsIds>
  <LeadSourceId>4</LeadSourceId>
  <LeadStageId>5</LeadStageId>
  <PageNumber>7</PageNumber>
  <PageSize>8</PageSize>
  <ProjectId>6</ProjectId>
  <SegmentContacts xmlns:d2p1="http://schemas.datacontract.org/2004/07/BrokerServer.Models.CampaignModels">
    <d2p1:SegmentContactVm>
      <d2p1:Contact>sample string 4</d2p1:Contact>
      <d2p1:ContactCC>sample string 3</d2p1:ContactCC>
      <d2p1:Email>sample string 5</d2p1:Email>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsEmail>true</d2p1:IsEmail>
      <d2p1:IsEmailVerified>true</d2p1:IsEmailVerified>
      <d2p1:IsMobile>true</d2p1:IsMobile>
      <d2p1:IsMobileVerified>true</d2p1:IsMobileVerified>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SegmentId>1</d2p1:SegmentId>
    </d2p1:SegmentContactVm>
    <d2p1:SegmentContactVm>
      <d2p1:Contact>sample string 4</d2p1:Contact>
      <d2p1:ContactCC>sample string 3</d2p1:ContactCC>
      <d2p1:Email>sample string 5</d2p1:Email>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsEmail>true</d2p1:IsEmail>
      <d2p1:IsEmailVerified>true</d2p1:IsEmailVerified>
      <d2p1:IsMobile>true</d2p1:IsMobile>
      <d2p1:IsMobileVerified>true</d2p1:IsMobileVerified>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SegmentId>1</d2p1:SegmentId>
    </d2p1:SegmentContactVm>
  </SegmentContacts>
  <SegmentId>1</SegmentId>
  <Type>sample string 2</Type>
  <UserId>3</UserId>
</SegmentContactPostVm>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SegmentContactPostVm'.

Response Information

Resource Description

Response
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

Description

string

None.

Data

Object

None.

Count

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "Description": "sample string 3",
  "Data": {},
  "Count": 5
}

application/xml, text/xml

Sample:
<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Models">
  <Count>5</Count>
  <Data />
  <Description>sample string 3</Description>
  <Message>sample string 2</Message>
  <Success>true</Success>
</Response>