API Method /users/relations/remove
Removes a relation between the logged in user and a target user.
Arguments
- authentication
- This method requires user authentication.
- member_id string
- The target user ID of the user to remove a relationship with. The authenticated user is the user creating the relationship.
- relation string
- The relation type, either "friends", "family", or "contacts".
-
Example Request
Here's an example request URL:
http://api.evdb.com/rest/users/relations/remove?...&member_id=chris&relation=contacts
Output Parameters
Output from this function is an XML block with the following constructs:
- status string
- ok
- messagestring
- User 'user' removed as relationship 'relation'
Example XML Response
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<message>User 'chris' removed as relationship 'contacts'</message>
</response>
Error Codes
This method may return these errors in an error document:
- Authentication error
- The specified user was not found or provided invalid credentials.
- Missing parameter
- The locale parameter is mandatory.
- Not found
- The user id was not found.
-