POST
Deactivate a profile assignment (company)
Company space User accounts only For: Administrator · Permission: user_profiles.update Conditions
  • The assignment of a built-in profile (administrator, read only) cannot be deactivated.
  • A caller cannot deactivate their own assignment.
  • When it would leave the member with no active assignment in the space, the member is deactivated too; this is refused with 403 (and nothing changes) if the member is the owner of the company.
What else happens
  • Sets the assignment inactive.
  • Revokes the public accounting export shares created by that assignment; they stay revoked if the assignment is reactivated.
  • Deactivates the member of the space when no other active assignment remains.
Part of Assign access to people.

Authorizations

Authorization
string
header
required

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

Path Parameters

userProfileId
string
required

Identifier of the profile assignment (the link between a member and a profile in this company space), not of the profile itself.

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, is_active, updated_at, created_at, is_default, working_hours, is_current, is_direct_seller.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: profile, profile.groupedRoles, company, company.organization, client, organization.

Response

Resource (only with response=resource).

id

Identifier of the profile assignment (27-character KSUID string).

is_active
boolean

Whether the assignment is active. An inactive assignment cannot be used to sign in or switch profile.

updated_at

Date and time the record was last changed (ISO 8601, UTC).

created_at

Date and time the record was created (ISO 8601, UTC).

is_default
boolean

Whether this is the person's default assignment, a preference the apps can use to choose a profile. A person has at most one default per kind of space (companies, clients or organizations).

working_hours
object | null

Time windows during which the person may use this assignment, as opening hours per weekday (monday to sunday, each a list of HH:MM-HH:MM ranges) with optional dated exceptions, or null when there is no restriction. Companies can also define their own hours.

is_current
boolean

Whether the profile of this assignment is the profile of the session making the request.

is_direct_seller
boolean

Whether the assignment counts as a direct seller. Always false outside company spaces.

profile
object

Profile of the assignment. Only present when requested with include=profile.

company
object

Company that owns the assignment. Only present for company assignments and when requested with include=company.

client
object

Client that owns the assignment. Only present for client assignments and when requested with include=client.

organization
object

Organization that owns the assignment. Only present for organization assignments and when requested with include=organization.