<
**Version** kernel-3.7.0
[**Terms of Service**]()
# APIs
## /absSync/lists/{tenantId}/{listId}
### GET
<a id="getList">Get list</a>
This gets the list referenced by tenantId and listId.
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>listId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the List</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | List is geted successfully. | - |
| 400 | Invalid input. | - |
| 404 | List does not exist at Address Book Server. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
### PUT
<a id="addOrOverwriteList">Create/update list</a>
This creates or updates the list referenced by tenantId and listId.
#### Request
**Content-Type: ** application/json
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>listId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the List</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>body</th>
<td>body</td>
<td>yes</td>
<td>The data related to the List</td>
<td> - </td>
<td>
<a href="#/definitions/ListData">ListData</a>
</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | List is created/updated successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
### DELETE
<a id="deleteList">Delete list</a>
This deletes list referenced by tenantId and listId.
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>listId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the List</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | List is deleted successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
## /absSync/lists/{tenantId}/{listId}/accessors
### GET
<a id="getAccessors">Get list of accessors</a>
This gets alist of accessors referenced by tenantId and listId.
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>listId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the List</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | List of accessors is geted successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
### PUT
<a id="addOrOverwriteAccessorsForList">Create/update accessors of list</a>
This creates or updates the accessors of list referenced by tenantId and listId.
#### Request
**Content-Type: ** application/json
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>listId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the List</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>body</th>
<td>body</td>
<td>yes</td>
<td>The accessors data</td>
<td> - </td>
<td>
Array[<a href="#/definitions/UserID">UserID</a>]
</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | Accessors of list is created/updated successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
### POST
<a id="addRemoveOrUpdateAccessorsForList">Create/update accessors of list</a>
This creates or updates the accessors of list referenced by tenantId and listId.
#### Request
**Content-Type: ** application/json
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>listId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the List</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>body</th>
<td>body</td>
<td>yes</td>
<td>The accessors data</td>
<td> - </td>
<td>
Array[<a href="#/definitions/UserID">UserID</a>]
</td>
</tr>
<tr>
<th>op</th>
<td>query</td>
<td>no</td>
<td>The operation name of Accessors in List</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | Accessors of list is created/updated successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
### DELETE
<a id="deleteAccessorsFromList">Delete accessors from list</a>
Delete all accessors from list referenced by listId and tenantId.
#### Request
**Content-Type: ** application/json
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>listId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the List</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | Accessors removed successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
## /absSync/lists/{tenantId}/{listId}/members
### GET
<a id="getMembers">Get list of members</a>
This gets a list of members referenced by tenantId and listId.
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>listId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the List</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | List of members got successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
### PUT
<a id="addOrOverwriteMembersToList">Create/update members of list</a>
Initially set or reset the all members of the list referenced by listId and tenantId.
#### Request
**Content-Type: ** application/json
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique eco system identifier.</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>listId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the list.</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>body</th>
<td>body</td>
<td>yes</td>
<td>The members of the list.</td>
<td> - </td>
<td>
Array[<a href="#/definitions/UserID">UserID</a>]
</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | Members where created/updated successfully | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
### POST
<a id="addRemoveOrUpdateMembersToList">Create/update members of list</a>
Initially set or reset the all members of the list referenced by listId and tenantId.
#### Request
**Content-Type: ** application/json
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique eco system identifier.</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>listId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the list.</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>body</th>
<td>body</td>
<td>yes</td>
<td>The members of the list.</td>
<td> - </td>
<td>
Array[<a href="#/definitions/UserID">UserID</a>]
</td>
</tr>
<tr>
<th>op</th>
<td>query</td>
<td>no</td>
<td>The operation name of Members To List</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | Members where created/updated successfully | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
### DELETE
<a id="deleteMembersFromList">Delete members of list</a>
Delete all members from list referenced by listId and tenantId.
#### Request
**Content-Type: ** application/json
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>listId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the List</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | Members of list is deleted successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
## /absSync/lists/{tenantId}/{listId}/senders
### GET
<a id="getSenders">Get list of senders</a>
This gets a list of senders referenced by tenantId and listId.
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>listId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the List</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | List of senders got successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
### PUT
<a id="addOrOverwriteSendersForList">Create/update senders of list</a>
This creates or updates the senders of list referenced by tenantId and listId.
#### Request
**Content-Type: ** application/json
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>listId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the List</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>body</th>
<td>body</td>
<td>yes</td>
<td>The senders data</td>
<td> - </td>
<td>
Array[<a href="#/definitions/UserID">UserID</a>]
</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | Senders of list is created/updated successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
### POST
<a id="addRemoveOrUpdateSendersForList">Create/update senders of list</a>
This creates or updates the senders of list referenced by tenantId and listId.
#### Request
**Content-Type: ** application/json
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>listId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the List</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>body</th>
<td>body</td>
<td>yes</td>
<td>The senders data</td>
<td> - </td>
<td>
Array[<a href="#/definitions/UserID">UserID</a>]
</td>
</tr>
<tr>
<th>op</th>
<td>query</td>
<td>no</td>
<td>The operation name of Senders For List</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | Senders of list is created/updated successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
### DELETE
<a id="deleteSendersFromList">Delete senders from list</a>
Delete all senders from list referenced by listId and tenantId.
#### Request
**Content-Type: ** application/json
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>listId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the List</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | Senders removed successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
## /absSync/users/{tenantId}/{userId}
### GET
<a id="getUser">Get user</a>
This gets the user referenced by tenantId and userId.
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>userId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the User</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | User got successfully. | - |
| 400 | Invalid input. | - |
| 404 | User does not exist at Address Book Server. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
### PUT
<a id="addOrOverwriteUser">Create/update user</a>
This creates or updates the user referenced by tenantId and userId.
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>userId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the User</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>body</th>
<td>body</td>
<td>yes</td>
<td>The data related to the User</td>
<td> - </td>
<td>
<a href="#/definitions/UserData">UserData</a>
</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | User is created/updated successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
### DELETE
<a id="deleteUser">Delete user</a>
This deletes user referenced by tenantId and userId.
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>userId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the User</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | User is deleted successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
## /absSync/users/{tenantId}/{userId}/affiliations
### GET
<a id="getUserAffiliations">Get list of user affiliations</a>
This gets a list of user affiliations referenced by tenantId and userid.
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>userId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the User</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | List of user affiliations got successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
### PUT
<a id="addOrOverwriteUserAffiliations">Create/update user affiliations list</a>
This creates or updates the static list affiliations of user referenced by tenantId and userId. Lists are auto created in case they do not exist. The tenantId, listId, and category can be derived from the request body.
#### Request
**Content-Type: ** application/json
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>userId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the User</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>body</th>
<td>body</td>
<td>yes</td>
<td>The list of user affiliations</td>
<td> - </td>
<td>
<a href="#/definitions/UserAffiliations">UserAffiliations</a>
</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | User affiliations list is created/updated successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
### POST
<a id="addRemoveOrUpdateUserAffiliations">Create/update user affiliations list</a>
This creates or updates the static list affiliations of user referenced by tenantId and userId. Lists are auto created in case they do not exist. The tenantId, listId, and category can be derived from the request body.
#### Request
**Content-Type: ** application/json
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>userId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the User</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>body</th>
<td>body</td>
<td>yes</td>
<td>The list of user affiliations</td>
<td> - </td>
<td>
<a href="#/definitions/UserAffiliations">UserAffiliations</a>
</td>
</tr>
<tr>
<th>op</th>
<td>query</td>
<td>no</td>
<td>The operation name of User Affiliations</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | User affiliations list is created/updated successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
### DELETE
<a id="deleteUserAffiliations">Delete user affiliations</a>
This deletes user affiliations referenced by tenantId and userId.
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>userId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the User</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | User affiliations is deleted successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
## /absSync/users/{tenantId}/{userId}/attributes
### GET
<a id="getUserAttributes">Get list of user attributes</a>
This gets a list of user attributes referenced by tenantId and userid.
#### Request
**Content-Type: ** application/json
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>userId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the User</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>attributeType</th>
<td>query</td>
<td>yes</td>
<td>The data related to user 'static' attributes</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | List of user attributes is geted successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
### PUT
<a id="addOrOverwriteUserAttributes">Create/update user attributes</a>
This creates or updates the static or personal attributes of user referenced by tenantId and userId.
#### Request
**Content-Type: ** application/json
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>userId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the User</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>attributeType</th>
<td>query</td>
<td>yes</td>
<td>The data related to user 'static' attributes</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | User attributes is created/updated successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
### POST
<a id="addRemoveOrUpdateUserAttributes">Create/update user attributes</a>
This creates, updates or removes the static or personal attributes of user referenced by tenantId and userId.
#### Request
**Content-Type: ** application/json
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>userId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the User</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>attributeType</th>
<td>query</td>
<td>yes</td>
<td>The data related to user 'static' attributes</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>op</th>
<td>query</td>
<td>no</td>
<td>The operation name of User Attributes</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | User attributes is created/updated successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
### DELETE
<a id="deleteUserAttributes">Delete user attributes</a>
This deletes user attributes referenced by tenantId and userId.
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>userId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the User</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>attributeType</th>
<td>query</td>
<td>yes</td>
<td>The data related to user 'static' attributes</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | User attributes is deleted successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
## /absSync/users/{tenantId}/{userId}/lists
### GET
<a id="getUserLists">Get all lists of the user</a>
This gets all lists of user referenced by tenantId and userid.
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tenantId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the Tenant</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>userId</th>
<td>path</td>
<td>yes</td>
<td>The unique identifier of the User</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | Lists of user got successfully. | - |
| 400 | Invalid input. | - |
| 500 | Internal server error on synchronizing data, causes could be Address Book Synchronization is disabled, Operation timeout, general error, etc. | - |
| 503 | The server is currently unable to handle the request due to a temporary overloading, please try again later. | - |
# Definitions
## <a name="/definitions/ListData">ListData</a>
<table border="1">
<tr>
<th>name</th>
<th>type</th>
<th>required</th>
<th>description</th>
<th>example</th>
</tr>
<tr>
<td>type</td>
<td>
string
</td>
<td>required</td>
<td>-</td>
<td>static</td>
</tr>
<tr>
<td>category</td>
<td>
string
</td>
<td>required</td>
<td>-</td>
<td>'contact', 'chat' or 'broadcast'</td>
</tr>
<tr>
<td>attributes</td>
<td>
object
</td>
<td>required</td>
<td>-</td>
<td></td>
</tr>
</table>
## <a name="/definitions/ListID">ListID</a>
<table border="1">
<tr>
<th>name</th>
<th>type</th>
<th>required</th>
<th>description</th>
<th>example</th>
</tr>
<tr>
<td>ecoId</td>
<td>
string
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>listId</td>
<td>
string
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
</table>
## <a name="/definitions/UserAffiliations">UserAffiliations</a>
<table border="1">
<tr>
<th>name</th>
<th>type</th>
<th>required</th>
<th>description</th>
<th>example</th>
</tr>
<tr>
<td>contactListsMember</td>
<td>
array[<a href="#/definitions/ListID">ListID</a>]
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>contactListsAccessor</td>
<td>
array[<a href="#/definitions/ListID">ListID</a>]
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>chatGroupsMember</td>
<td>
array[<a href="#/definitions/ListID">ListID</a>]
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>broadcastListsMember</td>
<td>
array[<a href="#/definitions/ListID">ListID</a>]
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>broadcastListsSender</td>
<td>
array[<a href="#/definitions/ListID">ListID</a>]
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
</table>
## <a name="/definitions/UserData">UserData</a>
<table border="1">
<tr>
<th>name</th>
<th>type</th>
<th>required</th>
<th>description</th>
<th>example</th>
</tr>
<tr>
<td>userType</td>
<td>
string
</td>
<td>required</td>
<td>-</td>
<td>'person' or 'robot'</td>
</tr>
<tr>
<td>staticAttributes</td>
<td>
object
</td>
<td>optional</td>
<td>-</td>
<td>'key1':'value1'</td>
</tr>
</table>
## <a name="/definitions/UserID">UserID</a>
<table border="1">
<tr>
<th>name</th>
<th>type</th>
<th>required</th>
<th>description</th>
<th>example</th>
</tr>
<tr>
<td>userId</td>
<td>
string
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>ecoId</td>
<td>
string
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
</table>
]]>