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

# Update current user profile

> Updates the authenticated user profile fields (name, email, phone, designation, persona, automations, notification preferences, call forwarding). Returns 409 if the new email is already in use.



## OpenAPI

````yaml /api-reference/openapi.yaml put /api/user/profile
openapi: 3.0.3
info:
  title: Tether Relay and Tether API
  version: 1.0.0
  description: >-
    Route-derived OpenAPI contract generated from tether-relay backend sources.
    Regenerate with scripts/sync-openapi-from-backend.mjs.
servers:
  - url: https://your-instance.example.com
    description: Production
  - url: http://localhost:2212
    description: Local API service
security: []
tags:
  - name: AI
  - name: Applications
  - name: Approval
  - name: Auth
  - name: Automations
  - name: Calls
  - name: Campaigns
  - name: Contact Analytics
  - name: Contact Metrics
  - name: Contact Notes
  - name: Contacts
  - name: Conversation Monitor
  - name: Conversations
  - name: Departments
  - name: Email
  - name: Escalation Dashboard
  - name: Event Logs
  - name: Google Sheets
  - name: Marketplace
  - name: Messages
  - name: Notification Sounds
  - name: Notifications
  - name: Org Snapshots
  - name: Organizations
  - name: Outreach
  - name: Outreach Metrics
  - name: Outreach Sources
  - name: Pipelines
  - name: Processes
  - name: Prompts
  - name: Reminders
  - name: Sms
  - name: Templates
  - name: Traces
  - name: Training
  - name: Upload
  - name: User Snapshots
  - name: Users
  - name: Vertical
  - name: Webchats
  - name: Webhook
paths:
  /api/user/profile:
    put:
      tags:
        - User
      summary: Update current user profile
      description: >-
        Updates the authenticated user profile fields (name, email, phone,
        designation, persona, automations, notification preferences, call
        forwarding). Returns 409 if the new email is already in use.
      operationId: put_user_profile
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserUpdateProfileRequest'
      responses:
        '200':
          description: Profile updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserUpdateProfileResponse'
        '404':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserErrorResponse'
        '409':
          description: Email already in use
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    UserUpdateProfileRequest:
      type: object
      properties:
        fullName:
          type: string
          description: >-
            Display name shown across the UI and on outbound messages signed by
            this user.
        email:
          type: string
          format: email
          description: >-
            Primary login email; must be unique across all users — endpoint
            returns 409 if already taken.
        phoneNumber:
          type: string
          description: >-
            Personal mobile number (E.164 preferred); rejected if it collides
            with a provisioned organization SMS number.
        designation:
          type: string
          description: >-
            Free-form job title (e.g., "Senior Account Executive"); used for
            display only.
        sinchPhoneNumber:
          type: string
          description: >-
            Assigned Sinch outbound number; used as the from-number on
            user-attributed SMS.
        departmentId:
          type: string
          description: >-
            ObjectId of the Department the user belongs to; controls team
            visibility and routing.
        accessRole:
          type: string
          description: >-
            Role granted to the user: `SUPERADMIN`, `ADMIN`, `DEPARTMENT_HEAD`,
            `SALES_REP`.
        automations:
          type: object
          additionalProperties: true
          description: >-
            Per-user automation toggles and configuration (free-form map
            persisted as `Mixed` on the User document).
        callForwardingEnabled:
          type: boolean
          description: >-
            Whether inbound calls should be forwarded to the user personal phone
            when they are offline or busy.
        notificationPreferences:
          type: object
          additionalProperties: true
          description: >-
            Per-category notification toggles (aiResponses, automationTriggers,
            escalations, calls, etc.). See `UserNotificationPreferences`.
        persona:
          type: object
          description: >-
            Persona fields written to the user linked `Persona` document;
            created on first set, otherwise merged. `businessHours`/`timezone`
            require the org-level override flag.
          properties:
            user:
              type: string
              description: >-
                Display name used when the AI signs messages on behalf of this
                rep.
            position:
              type: string
              description: >-
                Title the AI uses in its signature/identity (e.g., "Leasing
                Manager").
            userEmail:
              type: string
              description: >-
                Contact email surfaced by the AI persona (may differ from the
                login email).
            organization:
              type: string
              description: Organization name the AI persona introduces itself with.
            organizationAddress:
              type: string
              description: >-
                Physical address the AI may share when prospects ask for
                location.
            leadProvider:
              type: string
              description: >-
                Source of leads being worked (e.g., "Facebook Lead Ads") —
                informs AI context.
            organizationWebsite:
              type: string
              description: Public website URL the AI may share with contacts.
            organizationCity:
              type: string
              description: >-
                City the organization operates from; used for localization in AI
                responses.
            region:
              type: string
              description: >-
                State/province/region used for localization and compliance
                hints.
            timezone:
              type: string
              description: >-
                IANA timezone (e.g., `America/Toronto`); requires
                `allowUserBusinessHoursOverride` to be enabled at the org.
            businessHours:
              type: string
              description: >-
                Per-day availability windows for the AI; requires
                `allowUserBusinessHoursOverride` to be enabled at the org.
          additionalProperties: true
      additionalProperties: true
      example:
        fullName: Alex Rep
        email: alex@acme.example
        phoneNumber: '+14155550199'
        designation: Senior Account Executive
        callForwardingEnabled: true
    UserUpdateProfileResponse:
      type: object
      description: >-
        Returned after `PUT /api/user/profile`. Returns the refreshed user plus
        the updated persona side-by-side.
      properties:
        user:
          type: object
          additionalProperties: true
          description: Refreshed User document (with sensitive fields stripped).
        persona:
          $ref: '#/components/schemas/UserPersona'
      required:
        - user
        - persona
      additionalProperties: true
      example:
        user:
          _id: 5f7b1c2e8a1d4e0012c3b4a5
          email: admin@acme.example
          fullName: Acme Admin
          phoneNumber: '+14165550100'
          organizationId: 64a1b2c3d4e5f60012345678
          accessRole: ADMIN
        persona:
          position: Leasing Manager
          region: Toronto
          timezone: America/Toronto
    UserErrorResponse:
      type: object
      description: >-
        Generic error envelope returned by Users endpoints. Most paths only
        include `error`; some add `details` for diagnostic context.
      properties:
        error:
          type: string
        details:
          type: string
      required:
        - error
      additionalProperties: true
      example:
        error: User not found
        details: No user with id 64ee9a8b1e7f2a0011223399
    UserPersona:
      type: object
      description: Persona document linked to a user (may be null when unset).
      properties:
        _id:
          type: string
        user:
          type: string
        position:
          type: string
        userEmail:
          type: string
        organization:
          type: string
        organizationAddress:
          type: string
        leadProvider:
          type: string
        organizationWebsite:
          type: string
        organizationCity:
          type: string
        region:
          type: string
        timezone:
          type: string
        businessHours:
          type: string
      additionalProperties: true
      example:
        _id: 64eea1110000000000000040
        user: Alex Rep
        position: Senior Account Executive
        userEmail: alex@acme.example
        organization: Acme Corp
        organizationAddress: 500 Bay St, Toronto, ON
        leadProvider: Facebook Lead Ads
        organizationWebsite: https://acme.example
        organizationCity: Toronto
        region: Ontario
        timezone: America/Toronto
        businessHours: 9am-6pm Mon-Fri
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````