POST api/v4/addressbook/contacts

This method adds multiple contacts to the system. The system checks that the mobile numbers and email address are valid and if the validation is requested, the system will send a message to the contact to check the details are correct.

Request Information

URI Parameters

None.

Body Parameters

Either xml or json request.

TwoSms.CustomerPortalRole.API.AddressBooks.AddressBookLiteV2
NameDescriptionTypeAdditional information
GroupID

globally unique identifier

None.

contacts

Collection of TwoSms.CustomerPortalRole.API.AddressBooks.AddressBookLite

None.

Request Formats

application/json, text/json

Sample:
{
  "contacts": [
    {
      "EmailAddress": "sample string 7",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "MobilePhone": "sample string 6",
      "LoginType": 9,
      "Password": "sample string 8",
      "Validated": true
    },
    {
      "EmailAddress": "sample string 7",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "MobilePhone": "sample string 6",
      "LoginType": 9,
      "Password": "sample string 8",
      "Validated": true
    }
  ],
  "GroupID": "84c3ca1e-58bc-40ea-b354-69f854078786"
}

application/xml, text/xml

Sample:
<AddressBookLiteV2 xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <contacts>
    <AddressBookLite>
      <FirstName>sample string 4</FirstName>
      <LastName>sample string 5</LastName>
      <MobilePhone>sample string 6</MobilePhone>
      <EmailAddress>sample string 7</EmailAddress>
      <Password>sample string 8</Password>
      <LoginType>9</LoginType>
      <Validated>true</Validated>
      <PersonNumber>1</PersonNumber>
      <DateCreated>2021-02-27T06:45:16.0401345+00:00</DateCreated>
      <DateModified>2021-02-27T06:45:16.0401345+00:00</DateModified>
      <LastModifiedBy>sample string 2</LastModifiedBy>
      <OwnerAccountID>1dbb2d1a-eb72-4963-af90-43c14d27d56d</OwnerAccountID>
      <LegacyPersonNumber>1</LegacyPersonNumber>
    </AddressBookLite>
    <AddressBookLite>
      <FirstName>sample string 4</FirstName>
      <LastName>sample string 5</LastName>
      <MobilePhone>sample string 6</MobilePhone>
      <EmailAddress>sample string 7</EmailAddress>
      <Password>sample string 8</Password>
      <LoginType>9</LoginType>
      <Validated>true</Validated>
      <PersonNumber>1</PersonNumber>
      <DateCreated>2021-02-27T06:45:16.0401345+00:00</DateCreated>
      <DateModified>2021-02-27T06:45:16.0401345+00:00</DateModified>
      <LastModifiedBy>sample string 2</LastModifiedBy>
      <OwnerAccountID>1dbb2d1a-eb72-4963-af90-43c14d27d56d</OwnerAccountID>
      <LegacyPersonNumber>1</LegacyPersonNumber>
    </AddressBookLite>
  </contacts>
  <GroupID>84c3ca1e-58bc-40ea-b354-69f854078786</GroupID>
</AddressBookLiteV2>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Details of the last contact that has been created.

TwoSms.CustomerPortalRole.API.Misc.ResponseOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.AddressBooks.AddressBookResponse
NameDescriptionTypeAdditional information
Error

TwoSms.CustomerPortalRole.API.Misc.Error

None.

ResponseData

TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.AddressBooks.AddressBookResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": [
      {
        "PersonNumber": 3,
        "DateCreated": "2021-02-27T06:45:16.0561344+00:00",
        "DateModified": "2021-02-27T06:45:16.057137+00:00",
        "EmailAddress": "sample string 9",
        "FirstName": "sample string 6",
        "Groups": "sample string 2",
        "Inherited": true,
        "LastName": "sample string 7",
        "LastModifiedBy": "sample string 4",
        "MobilePhone": "sample string 8",
        "LoginType": 11,
        "OwnerAccountID": "575d8e2e-75ab-4331-a998-7a640eae69e7",
        "Password": "sample string 10",
        "PermissionLevel": 0,
        "Validated": true
      },
      {
        "PersonNumber": 3,
        "DateCreated": "2021-02-27T06:45:16.0561344+00:00",
        "DateModified": "2021-02-27T06:45:16.057137+00:00",
        "EmailAddress": "sample string 9",
        "FirstName": "sample string 6",
        "Groups": "sample string 2",
        "Inherited": true,
        "LastName": "sample string 7",
        "LastModifiedBy": "sample string 4",
        "MobilePhone": "sample string 8",
        "LoginType": 11,
        "OwnerAccountID": "575d8e2e-75ab-4331-a998-7a640eae69e7",
        "Password": "sample string 10",
        "PermissionLevel": 0,
        "Validated": true
      }
    ]
  }
}

application/xml, text/xml

Sample:
<ResponseOfListOfAddressBookResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <AddressBookResponse>
        <FirstName>sample string 6</FirstName>
        <LastName>sample string 7</LastName>
        <MobilePhone>sample string 8</MobilePhone>
        <EmailAddress>sample string 9</EmailAddress>
        <Password>sample string 10</Password>
        <LoginType>11</LoginType>
        <Validated>true</Validated>
        <PersonNumber>3</PersonNumber>
        <DateCreated>2021-02-27T06:45:16.0561344+00:00</DateCreated>
        <DateModified>2021-02-27T06:45:16.057137+00:00</DateModified>
        <LastModifiedBy>sample string 4</LastModifiedBy>
        <OwnerAccountID>575d8e2e-75ab-4331-a998-7a640eae69e7</OwnerAccountID>
        <Inherited>true</Inherited>
        <PermissionLevel>NONE</PermissionLevel>
        <Groups>sample string 2</Groups>
      </AddressBookResponse>
      <AddressBookResponse>
        <FirstName>sample string 6</FirstName>
        <LastName>sample string 7</LastName>
        <MobilePhone>sample string 8</MobilePhone>
        <EmailAddress>sample string 9</EmailAddress>
        <Password>sample string 10</Password>
        <LoginType>11</LoginType>
        <Validated>true</Validated>
        <PersonNumber>3</PersonNumber>
        <DateCreated>2021-02-27T06:45:16.0561344+00:00</DateCreated>
        <DateModified>2021-02-27T06:45:16.057137+00:00</DateModified>
        <LastModifiedBy>sample string 4</LastModifiedBy>
        <OwnerAccountID>575d8e2e-75ab-4331-a998-7a640eae69e7</OwnerAccountID>
        <Inherited>true</Inherited>
        <PermissionLevel>NONE</PermissionLevel>
        <Groups>sample string 2</Groups>
      </AddressBookResponse>
    </Detail>
  </ResponseData>
</ResponseOfListOfAddressBookResponse>