MembershipsMember

Add Member

Use this endpoint to add a new member to a membership. This is used when a new individual needs to be linked to an existing membership, either at the time of membership creation or later.

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

membershipIdUUIDRequired

Unique identifier for a membership.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-api-versiondateOptional

Used for API versioning. More details.

Query parameters

allowMergeOnConflictintegerOptional

Determines how the system should handle member uniqueness conflicts when adding or updating a member. This setting enforces community rules regarding member duplication and allows for automated resolution through member merging.

Options:

  • 0 (default): Do not merge.

    • If a member conflict is detected (i.e., another member exists that violates uniqueness rules), the request will be rejected with an error indicating a member conflict.
    • This ensures no changes are made to existing members and prevents unintended merges.

  • 1 (allow merge): Merge members according to the community’s uniqueness configuration.

    • The member specified in the request (being added or updated) will take precedence.
    • All other conflicting members will be deleted and their associations (e.g., memberships, cards) will be transferred to the surviving member.
    • Merging occurs only if the community setup explicitly permits member merging for the detected conflict scenario.
    • No merge will occur if the community configuration disallows merging, even if this parameter is set to 1.

Important Notes:

  • Member merges are irreversible. Deleted members cannot be recovered after a successful merge.
  • Transferred associations include memberships, cards and other data linked to the conflicting members.
  • If no conflicts are found, setting this parameter has no effect.

Request

This endpoint expects an object.
memberobjectRequired

This is a request DTO used to create or update a Member along with their associated cards. It extends the MemberEntityRequest and optionally includes a list of cards for the member.

Response

This endpoint returns an object.
memberobject

This is a composite type representing a Member and the Memberships they are associated with. It extends the MemberEntity and includes a list of memberships to which the member belongs.