API-Keys
POSTADITUS/Byndr/Connections/edit note

edit note

POST{{API_BASE_URL}}/byndr/v1/users/:initiatorUserId/connections/:targetUserId/notes/:event

Add Note to User Connection

This endpoint allows you to add a note to a specific connection between two users identified by their user IDs and related to a specific event encounter. The note can contain any relevant information or comments that you wish to associate with the connection.

Request

  • Method: POST

  • URL: {{API_BASE_URL}}/byndr/v1/users/:initiatorUserId/connections/:targetUserId/notes/:event

Path Parameters

  • initiatorUserId (string): The ID of the user initiating the request.

  • targetUserId (string): The ID of the user to whom the initiator is connected to.

  • event (string): The event type associated with the note.

Request Body

The request body must be in JSON format and should include the following key:

  • Note (string): A textual note that you want to associate with the connection. For example, you might include comments or observations relevant to the connection.

Example Request Body:

{
"Note": "BEST DOCTOR IN ALL OCEANS!!"
}

Response

  • Status Code: 200 OK

  • Content-Type: text/xml

  • Body: The response body may not contain any additional data, but a successful status indicates that the note was added successfully.

Authentication#auth

This endpoint does not require authentication.

Responses#responses

200OKedit note