Skip to main content
POST
Create User Relationship

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-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
userId
string
required
relationshipType
enum<string>
required
Available options:
USER_RELATIONSHIP_TYPE_UNSPECIFIED,
USER_RELATIONSHIP_TYPE_MANAGER
pin
boolean | null

Pin the assignment against automation (user ingestion) overwrites. Defaults by principal: user-token writes pin, API-key writes don't. Release through UpdateUser's release_fields (MANAGER).

Response

200 - application/json

Success

data
data · object