Zum Hauptinhalt gehen

API Documentation

  • Aktualisiert

Base URL

The base URL is unique for each user. It can be retrieved from the Community Settings menu under the "API" section. The format of the base URL is:

https://www.membado.io/api/xx

Where xx represents the community ID.

Endpoint: /add-member

Description:

This endpoint allows you to assign or remove tags from a user. No email is sent to the user, and no account is created in the process.

  • If the user does not already have an account: The system stores the assigned tags for future reference, so they can be applied automatically if the user registers later.
  • If the tag is linked to a course within a community: The user will be invited to the corresponding community in Membado. The invitation allows the user to join without additional verification.

Method: POST

Parameters

Name Type Required Description
apikey string Yes The API key, which must be generated in the Community Settings menu under "API".
mail string Yes The email address of the user to whom the tags should be assigned or removed.
tags_add string No A comma-separated list of tag IDs to assign to the user.
tags_remove string No A comma-separated list of tag IDs to remove from the user.

Request Example

URL:

https://www.membado.io/api/xx/add-member

Content:

apikey: your_api_key_here
mail: user@example.com
tags_add: 123,456,789
tags_remove: 101,202

Response

Success

Status Code: 200 OK

Failure

Status Code: 400 Bad Request

Possible reasons:

  • Missing or invalid API key.
  • Missing mail parameter.
  • Invalid tag IDs in tags_add or tags_remove

Notes

  • The apikey parameter must be securely stored and should not be shared publicly.
  • Ensure the tags_add and tags_remove values contain valid tag IDs that exist in your community.
  • If no account exists for the given email address, tags are stored for future use when the user registers.

Verwandte Beiträge