> ## Documentation Index
> Fetch the complete documentation index at: https://docs.serval.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create User Relationship

> Create or update a user relationship. If a relationship already exists, it will be updated.

## 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.

| Credential | Access requirements |
| - | - |
| Organization-scoped API key | `users:manage` |
| Team-scoped API key | Unsupported |
| User-based token (OAuth) | Supported, subject to permissions |

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.


## OpenAPI

````yaml /sections/api-reference/openapi-spec-v2.yaml post /v2/user-relationships
openapi: 3.1.0
info:
  title: Serval Public API
  description: Serval Public API
  contact:
    name: Serval
    url: https://serval.com
    email: support@serval.com
  license:
    name: Serval License
    url: https://serval.com/license
  version: 2.0.0
servers:
  - url: https://public.api.serval.com
security:
  - BearerAuth: []
tags:
  - name: Access Membership API
  - name: Access Policy API
  - name: Access Policy Approval Procedure API
  - name: Access Profile API
  - name: Access Relationship API
  - name: Access Request API
  - name: Agent API
  - name: Analytics API
  - name: App Instance API
  - name: App Resource API
  - name: App Resource Role API
  - name: Approval Delegation API
  - name: Approval Procedure API
  - name: Approval Request API
  - name: Assignment Rules API
  - name: Audit Log API
  - name: Campaign API
  - name: Change Blackout API
  - name: Change Model API
  - name: Connected Channels API
  - name: Custom Field API
  - name: Custom Role API
  - name: Custom Service API
  - name: Dashboards API
  - name: Email Intake API
  - name: Entity API
  - name: Entity Field Mapping API
  - name: Entity Ingestion Config API
  - name: Entity Type API
  - name: Folder API
  - name: Forms API
  - name: Group API
  - name: Guidance API
  - name: Help Agent API
  - name: Journey API
  - name: Knowledge API
  - name: Knowledge Base API
  - name: One-Time Window API
  - name: Report API
  - name: Review API
  - name: Roles API
  - name: SLA API
  - name: Schedule API
  - name: Tag API
  - name: Team API
  - name: Team Group API
  - name: Team SDLC Settings API
  - name: Team User API
  - name: Ticket API
  - name: Topic API
  - name: User API
  - name: User Relationship API
  - name: Widgets API
  - name: Worker API
  - name: Workflow API
  - name: Workflow Approval Procedure API
  - name: Workflow Run API
paths:
  /v2/user-relationships:
    post:
      tags:
        - User Relationship API
      summary: Create User Relationship
      description: >-
        Create or update a user relationship. If a relationship already exists,
        it will be updated.
      operationId: svrelay.publicv2.PublicAPIServiceV2.CreateUserRelationship
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/svauth.public.CreateUserRelationshipRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/svauth.public.CreateUserRelationshipResponse
      security:
        - BearerAuth: []
components:
  schemas:
    svauth.public.CreateUserRelationshipRequest:
      type: object
      properties:
        userId:
          type: string
          title: user_id
          x-stainless-terraform-configurability: required
        relatedUserId:
          type: string
          title: related_user_id
          x-stainless-terraform-configurability: required
        relationshipType:
          $ref: '#/components/schemas/svauth.public.UserRelationshipType'
          title: relationship_type
          x-stainless-terraform-configurability: required
        pin:
          type:
            - boolean
            - 'null'
          title: pin
          description: |-
            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).
          x-stainless-terraform-configurability: optional
      title: CreateUserRelationshipRequest
      required:
        - userId
        - relatedUserId
        - relationshipType
      additionalProperties: false
    svauth.public.CreateUserRelationshipResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/svauth.public.UserRelationship'
          title: data
          x-stainless-terraform-configurability: optional
      title: CreateUserRelationshipResponse
      additionalProperties: false
    svauth.public.UserRelationshipType:
      type: string
      title: UserRelationshipType
      enum:
        - USER_RELATIONSHIP_TYPE_UNSPECIFIED
        - USER_RELATIONSHIP_TYPE_MANAGER
    svauth.public.UserRelationship:
      type: object
      properties:
        userId:
          type: string
          title: user_id
          x-stainless-terraform-configurability: optional
        relatedUserId:
          type: string
          title: related_user_id
          x-stainless-terraform-configurability: optional
        relationshipType:
          $ref: '#/components/schemas/svauth.public.UserRelationshipType'
          title: relationship_type
          x-stainless-terraform-configurability: optional
        createdAt:
          $ref: '#/components/schemas/google.protobuf.Timestamp'
          title: created_at
          readOnly: true
          x-stainless-terraform-configurability: computed
      title: UserRelationship
      additionalProperties: false
    google.protobuf.Timestamp:
      type: string
      examples:
        - '2025-01-15T01:30:15.000Z'
        - '2025-06-01T00:00:00.000Z'
      format: date-time
      description: A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z").
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.