Removing User Connections

This API is executed using API-User credentials and is used to remove an existing connection request (in any status) between two users. It can be used to cancel an active or pending connection between a sub-account, primary account, or consumer.

Request Body Parameters:

  • fromUserId: The ID of the user who is currently connected. This can be a sub-account, primary account, or consumer.
  • toUserId: The ID of the user to whom the connection was made. This can also be a sub-account, primary account, or consumer.

Response:

  • OK: Indicates that the connection was successfully removed.
  • BadRequest: Indicates an issue with the request (e.g., invalid user IDs or connection status).

Security:

  • API-User credentials are required to call this API.
  • Proper validation should ensure that the connection being removed is valid and authorized to be unlinked.
Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!