POST api/Phonelists/AddMultipleEntries

Adds multiple entries to a phone list

Request Information

URI Parameters

None.

Body Parameters

List of entries to be added

MultiplePhoneListEntry
NameDescriptionTypeAdditional information
SessionToken

string

None.

ListID

integer

None.

ListEntries

Collection of NewPhoneListEntry

None.

Request Formats

application/json, text/json

Sample:
{
  "SessionToken": "sample string 1",
  "ListID": 2,
  "ListEntries": [
    {
      "PhoneNumber": "sample string 1",
      "Title": "sample string 2",
      "FirstName": "sample string 3",
      "Surname": "sample string 4",
      "Address1": "sample string 5",
      "Address2": "sample string 6",
      "Address3": "sample string 7",
      "City": "sample string 8",
      "County": "sample string 9",
      "Postcode": "sample string 10",
      "Gender": "sample string 11",
      "DateOfBirth": "2025-05-20T13:27:03.7203179+01:00",
      "Reference": "sample string 12",
      "Email": "sample string 13",
      "User1": "sample string 14",
      "User2": "sample string 15",
      "User3": "sample string 16"
    },
    {
      "PhoneNumber": "sample string 1",
      "Title": "sample string 2",
      "FirstName": "sample string 3",
      "Surname": "sample string 4",
      "Address1": "sample string 5",
      "Address2": "sample string 6",
      "Address3": "sample string 7",
      "City": "sample string 8",
      "County": "sample string 9",
      "Postcode": "sample string 10",
      "Gender": "sample string 11",
      "DateOfBirth": "2025-05-20T13:27:03.7203179+01:00",
      "Reference": "sample string 12",
      "Email": "sample string 13",
      "User1": "sample string 14",
      "User2": "sample string 15",
      "User3": "sample string 16"
    }
  ]
}

application/xml, text/xml

Sample:
<MultiplePhoneListEntry xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMSConnector">
  <ListEntries>
    <NewPhoneListEntry>
      <Address1>sample string 5</Address1>
      <Address2>sample string 6</Address2>
      <Address3>sample string 7</Address3>
      <City>sample string 8</City>
      <County>sample string 9</County>
      <DateOfBirth>2025-05-20T13:27:03.7203179+01:00</DateOfBirth>
      <Email>sample string 13</Email>
      <FirstName>sample string 3</FirstName>
      <Gender>sample string 11</Gender>
      <PhoneNumber>sample string 1</PhoneNumber>
      <Postcode>sample string 10</Postcode>
      <Reference>sample string 12</Reference>
      <Surname>sample string 4</Surname>
      <Title>sample string 2</Title>
      <User1>sample string 14</User1>
      <User2>sample string 15</User2>
      <User3>sample string 16</User3>
    </NewPhoneListEntry>
    <NewPhoneListEntry>
      <Address1>sample string 5</Address1>
      <Address2>sample string 6</Address2>
      <Address3>sample string 7</Address3>
      <City>sample string 8</City>
      <County>sample string 9</County>
      <DateOfBirth>2025-05-20T13:27:03.7203179+01:00</DateOfBirth>
      <Email>sample string 13</Email>
      <FirstName>sample string 3</FirstName>
      <Gender>sample string 11</Gender>
      <PhoneNumber>sample string 1</PhoneNumber>
      <Postcode>sample string 10</Postcode>
      <Reference>sample string 12</Reference>
      <Surname>sample string 4</Surname>
      <Title>sample string 2</Title>
      <User1>sample string 14</User1>
      <User2>sample string 15</User2>
      <User3>sample string 16</User3>
    </NewPhoneListEntry>
  </ListEntries>
  <ListID>2</ListID>
  <SessionToken>sample string 1</SessionToken>
</MultiplePhoneListEntry>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The number of entries which were accepted

APIReturnOfPhoneListStatusAndIEnumerableOfAddEntryDetailCount
NameDescriptionTypeAdditional information
StatusEnum

PhoneListStatus

None.

Status

string

None.

Result

Collection of AddEntryDetailCount

None.

Response Formats

application/json, text/json

Sample:
{
  "StatusEnum": 0,
  "Status": "Success",
  "Result": [
    {
      "Key": 0,
      "KeyString": "sample string 1",
      "Count": 2
    },
    {
      "Key": 0,
      "KeyString": "sample string 1",
      "Count": 2
    }
  ]
}

application/xml, text/xml

Sample:
<APIReturnOfPhoneListStatusArrayOfAddEntryDetailCountuO2q6ph3 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMSConnector">
  <Result>
    <AddEntryDetailCount>
      <Count>2</Count>
      <Key>Success</Key>
      <KeyString>sample string 1</KeyString>
    </AddEntryDetailCount>
    <AddEntryDetailCount>
      <Count>2</Count>
      <Key>Success</Key>
      <KeyString>sample string 1</KeyString>
    </AddEntryDetailCount>
  </Result>
  <StatusEnum>Success</StatusEnum>
</APIReturnOfPhoneListStatusArrayOfAddEntryDetailCountuO2q6ph3>