Stop sharing a parent's entitlement with a child Account

Ends the parent's share of one entitlement with this child Account. Authorization is the same as sharing: Write access to the child path Account and to its parent Account. With a future accessEndsAt, the entitlement winds down: it reads OffBoarding with notAfter set to that time. Without one, or with a past time, it reads Removed now. An entitlement the child holds from another source stays Active. Removing a share that has already ended changes nothing. Calling this again can only end access sooner: an earlier accessEndsAt moves notAfter to that time, no accessEndsAt removes the entitlement now, and a later one is ignored. To extend access, share the entitlement again, then remove it with the new date. Returns 404 when the Account holds no entitlement for the product.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Account identifier. Newly created V3 Accounts use a 22-character Wingspan ID; migrated Accounts may retain a 24-character lowercase hexadecimal ID.

string
enum
required

The product an entitlement grants. ContractorPayments is Payments (AP) Full, ArInvoicing is Collections (AR) Full, PaymentsBasic is Payments (AP) Basic, CollectionsBasic is Collections (AR) Basic and EmployeePayroll is Payroll.

Query Params
date-time

When the child's access ends, as a URL-encoded RFC 3339 date-time. A future time winds the entitlement down until then. Omit it to remove the entitlement now.

Headers
string
^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json