Block Member

POST

Block a specific member from further activity. This is typically used in scenarios where a member’s access needs to be temporarily or permanently disabled. Family Membership Downgrade For family or group memberships, when the allowed number of valid members decreases (e.g., before a downgrade to a smaller membership plan), this endpoint can be used to block excess members to comply with the new membership limitations.

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

memberIdintegerRequired

Unique identifier for a member.

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Response

This endpoint returns an object.
memberobject

The MemberEntityResponse extends the MemberEntityRequest and includes additional properties such as the member’s ID, membership number, and blocked status. This DTO is used when returning a member’s details.

cacheInstanceIdstringOptional

Identifier for the NST instance. Providing this value will increase the performance of the API when the NST is load-balanced.

Built with