POST api/Phonelists/AddSingleEntry
Adds an entry to a phone list
Request Information
URI Parameters
None.
Body Parameters
The entry to be added
SinglePhoneListEntry| Name | Description | Type | Additional information |
|---|---|---|---|
| SessionToken | string |
None. |
|
| ListID | integer |
None. |
|
| PhoneNumber | string |
None. |
|
| Title | string |
None. |
|
| FirstName | string |
None. |
|
| Surname | string |
None. |
|
| Address1 | string |
None. |
|
| Address2 | string |
None. |
|
| Address3 | string |
None. |
|
| City | string |
None. |
|
| County | string |
None. |
|
| Postcode | string |
None. |
|
| Gender | string |
None. |
|
| DateOfBirth | date |
None. |
|
| Reference | string |
None. |
|
| string |
None. |
||
| User1 | string |
None. |
|
| User2 | string |
None. |
|
| User3 | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"SessionToken": "sample string 1",
"ListID": 2,
"PhoneNumber": "sample string 3",
"Title": "sample string 4",
"FirstName": "sample string 5",
"Surname": "sample string 6",
"Address1": "sample string 7",
"Address2": "sample string 8",
"Address3": "sample string 9",
"City": "sample string 10",
"County": "sample string 11",
"Postcode": "sample string 12",
"Gender": "sample string 13",
"DateOfBirth": "2025-10-24T15:09:48.090468+01:00",
"Reference": "sample string 14",
"Email": "sample string 15",
"User1": "sample string 16",
"User2": "sample string 17",
"User3": "sample string 18"
}
application/xml, text/xml
Sample:
<SinglePhoneListEntry xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMSConnector"> <Address1>sample string 7</Address1> <Address2>sample string 8</Address2> <Address3>sample string 9</Address3> <City>sample string 10</City> <County>sample string 11</County> <DateOfBirth>2025-10-24T15:09:48.090468+01:00</DateOfBirth> <Email>sample string 15</Email> <FirstName>sample string 5</FirstName> <Gender>sample string 13</Gender> <PhoneNumber>sample string 3</PhoneNumber> <Postcode>sample string 12</Postcode> <Reference>sample string 14</Reference> <Surname>sample string 6</Surname> <Title>sample string 4</Title> <User1>sample string 16</User1> <User2>sample string 17</User2> <User3>sample string 18</User3> <ListID>2</ListID> <SessionToken>sample string 1</SessionToken> </SinglePhoneListEntry>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Indicator of whether the entry was added
APIReturnOfPhoneListStatusAndAddEntryDetail| Name | Description | Type | Additional information |
|---|---|---|---|
| StatusEnum | PhoneListStatus |
None. |
|
| Status | string |
None. |
|
| Result | AddEntryDetail |
None. |
Response Formats
application/json, text/json
Sample:
{
"StatusEnum": 0,
"Status": "Success",
"Result": 0
}
application/xml, text/xml
Sample:
<APIReturnOfPhoneListStatusAddEntryDetailuO2q6ph3 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMSConnector"> <Result>Success</Result> <StatusEnum>Success</StatusEnum> </APIReturnOfPhoneListStatusAddEntryDetailuO2q6ph3>