MembershipsMembership

Block Membership

Use this endpoint to block a membership, preventing any further activity on it.

Authentication

x-np-api-keystring
API Key authentication via header

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

x-api-versiondateOptional

Used for API versioning. More details.

Response

This endpoint returns an object.
membershipobject

Membership shape returned by the primary membership endpoints — get by id/number, get members, block/unblock, and create. Extends MembershipEntity with the full timeFrames array. Other membership responses (lifecycle history, lifecycle options, card responses, list) return the base MembershipEntity shape without timeFrames.