POSTADITUS/Byndr/Connections/Connect by quicode

Connect by quicode

POST{{API_BASE_URL}}/byndr/v1/users/:initiatorUserId/connections

Add Connection

This endpoint allows to create a new connection between the initiator and target users, or reconnect the respective users if a connection has been made in the past.

Request

  • Method: POST

  • URL: {{API_BASE_URL}}/byndr/v1/users/{{INITIATOR_USER_ID}}/connections

  • Request Body: The request must include a JSON object with the following parameter:

    • quicode (string): A unique code retrieved by scanning an attandee's badge (QR Code).

Example Request Body

{
  "quicode": "AS6JJP8H71K8NP" // or "http://quico.de/AS6JJP8H71K8NP"
}

Response

Upon a successful request, the API will return a JSON object containing the following fields:

  • data (object): An object containing the details of the connection.

    • status (string): The status of the connection.

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

    • targetUserId (string): The ID of the user being connected to.

    • eventId (string): An identifier for the event the scanned badge relates to.

    • dailyQuota (object): The daily quota response (see Get Daily Quota endpoint for more details)

Example Response

{
"data": {
"status": "",
"initiatorUserId": "",
"targetUserId": "",
"eventId": ""
}
}

Notes

  • Ensure that the quicode provided is valid to successfully create a connection.

  • A new connection can only happen if the daily limit is not reached. For more details see the get daily quota documentation

Authentication#auth

This endpoint does not require authentication.

Responses#responses

200OKConnect by quicode