Skip to main content
POST
Create Access Profile Grant

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

Authorizations

Authorization
string
header
required

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

Body

application/json
accessProfileId
string
required

The ID of the access profile the grant attaches to.

workflowId
string | null

Exactly one of the resource id fields below must be set; the field carries the resource kind. The resource must belong to the profile's team. Knowledge-item grants are read-only on this API (returned by the Get/List endpoints): knowledge gating is managed in-app, where grants inherit through the folder tree.

The ID of the workflow to grant.

appResourceRoleId
string | null

The ID of the app resource role to grant. A role belongs to at most one profile: granting it here removes it from any profile that currently holds it.

formId
string | null

The ID of the form to add this profile's users to the audience of.

skillId
string | null

The ID of the skill to add this profile's users to the audience of. A skill with no profiles linked can be loaded into the help-desk agent's context for anyone in the org; each linked profile narrows that.

Response

200 - application/json

Success

data
data · object

The kind of resource an access profile grant attaches to. One access-profile-to-resource attachment. For workflows and app resource roles the profile grants access; for forms and skills it narrows the audience (a form or skill with no grants reaches anyone in the org). Exactly one of the resource id fields is set; the field itself carries the resource kind, so cross-team tooling can resolve each id against its own resource type.