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.
AddressBookLiteV2Name | Description | Type | Additional information |
---|---|---|---|
GroupID | globally unique identifier |
None. |
|
contacts | Collection of 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": "7268712e-4eae-44ea-8c74-605db595e8e0" }
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>2024-10-09T10:40:50.469463+00:00</DateCreated> <DateModified>2024-10-09T10:40:50.469463+00:00</DateModified> <LastModifiedBy>sample string 2</LastModifiedBy> <OwnerAccountID>9df6d3e5-3582-4fcb-a737-64c91d9fad80</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>2024-10-09T10:40:50.469463+00:00</DateCreated> <DateModified>2024-10-09T10:40:50.469463+00:00</DateModified> <LastModifiedBy>sample string 2</LastModifiedBy> <OwnerAccountID>9df6d3e5-3582-4fcb-a737-64c91d9fad80</OwnerAccountID> <LegacyPersonNumber>1</LegacyPersonNumber> </AddressBookLite> </contacts> <GroupID>7268712e-4eae-44ea-8c74-605db595e8e0</GroupID> </AddressBookLiteV2>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Details of the last contact that has been created.
ResponseOfListOfAddressBookResponseName | Description | Type | Additional information |
---|---|---|---|
Error | Error |
None. |
|
ResponseData | ResponseDataOfListOfAddressBookResponse |
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": "2024-10-09T10:40:50.479423+00:00", "DateModified": "2024-10-09T10:40:50.479423+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": "5791cdef-fa56-46a5-9788-77af0e88c874", "Password": "sample string 10", "PermissionLevel": 0, "Validated": true }, { "PersonNumber": 3, "DateCreated": "2024-10-09T10:40:50.479423+00:00", "DateModified": "2024-10-09T10:40:50.479423+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": "5791cdef-fa56-46a5-9788-77af0e88c874", "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>2024-10-09T10:40:50.479423+00:00</DateCreated> <DateModified>2024-10-09T10:40:50.479423+00:00</DateModified> <LastModifiedBy>sample string 4</LastModifiedBy> <OwnerAccountID>5791cdef-fa56-46a5-9788-77af0e88c874</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>2024-10-09T10:40:50.479423+00:00</DateCreated> <DateModified>2024-10-09T10:40:50.479423+00:00</DateModified> <LastModifiedBy>sample string 4</LastModifiedBy> <OwnerAccountID>5791cdef-fa56-46a5-9788-77af0e88c874</OwnerAccountID> <Inherited>true</Inherited> <PermissionLevel>NONE</PermissionLevel> <Groups>sample string 2</Groups> </AddressBookResponse> </Detail> </ResponseData> </ResponseOfListOfAddressBookResponse>