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

# Update job referral partner

> Changes a referral partner's default split percentage, default payment mode, or both. Placements already logged keep their own partner splits. Returns `422 INVALID_SPLIT_PERCENTAGE` when `default_split_percentage` is not more than 0 and at most 100. Session and OAuth callers need the admin role or the "Edit jobs" permission. Needs `fees:write` for API keys.



## OpenAPI

````yaml /api-reference/openapi-v1.json patch /v1/jobs/{id}/referral-partners/{client_contact_id}
openapi: 3.1.0
info:
  title: Stardex API (v1)
  version: 1.0.0
  description: >-
    Stardex ATS API — manage candidates, jobs, companies, and recruiting
    workflows.
servers:
  - url: https://api.stardex.ai
    description: Production API server
security:
  - bearerAuth: []
tags:
  - name: Persons
    description: Manage person records — contacts, work history, and custom fields.
  - name: Jobs
    description: Manage job postings — pipeline stages, team members, and custom fields.
  - name: Candidates
    description: Manage candidate records and pipeline stage transitions.
  - name: Companies
    description: Browse and retrieve company records.
  - name: Lists
    description: Create, search, and retrieve saved person and company lists.
  - name: Person Activities
    description: Create and manage activity records (notes, emails, meetings) for persons.
  - name: Team Members
    description: List team members for use in search filters and assignments.
  - name: Custom Fields
    description: Retrieve custom field definitions and tag options for search filters.
  - name: Campaigns
    description: >-
      Create and edit email campaigns, enroll people through enrollment batches,
      and manage who is enrolled.
paths:
  /v1/jobs/{id}/referral-partners/{client_contact_id}:
    patch:
      tags:
        - Jobs
      summary: Update job referral partner
      description: >-
        Changes a referral partner's default split percentage, default payment
        mode, or both. Placements already logged keep their own partner splits.
        Returns `422 INVALID_SPLIT_PERCENTAGE` when `default_split_percentage`
        is not more than 0 and at most 100. Session and OAuth callers need the
        admin role or the "Edit jobs" permission. Needs `fees:write` for API
        keys.
      operationId: updateJobReferralPartner
      parameters:
        - schema:
            type: string
            format: uuid
            description: Job UUID.
          required: true
          description: Job UUID.
          name: id
          in: path
        - schema:
            type: string
            format: uuid
            description: Client contact UUID of the referral partner.
          required: true
          description: Client contact UUID of the referral partner.
          name: client_contact_id
          in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateJobReferralPartnerRequest'
      responses:
        '200':
          description: Referral partner updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobReferralPartnerResponse'
              example:
                success: true
                data:
                  client_contact_id: d2e3f4a5-b6c7-8901-defa-234567890123
                  person_id: e3f4a5b6-c7d8-9012-efab-345678901234
                  name: Priya Natarajan
                  title: Managing Partner
                  image_url: https://example.com/priya-natarajan.png
                  company_id: 678e9012-a34b-56c7-d890-123456789abc
                  company_name: Northwind Ventures
                  default_split_percentage: 10
                  default_mode: off_the_top
                  created_at: '2024-01-12T15:00:00Z'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                      details:
                        type: object
                        additionalProperties: {}
                        description: >-
                          Extra facts about the error when they help you fix it,
                          such as a limit and when it resets.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '403':
          description: >-
            Session and OAuth callers need the admin role or the "Edit jobs"
            permission
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                      details:
                        type: object
                        additionalProperties: {}
                        description: >-
                          Extra facts about the error when they help you fix it,
                          such as a limit and when it resets.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                      details:
                        type: object
                        additionalProperties: {}
                        description: >-
                          Extra facts about the error when they help you fix it,
                          such as a limit and when it resets.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '422':
          description: default_split_percentage is out of range
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                      details:
                        type: object
                        additionalProperties: {}
                        description: >-
                          Extra facts about the error when they help you fix it,
                          such as a limit and when it resets.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                      details:
                        type: object
                        additionalProperties: {}
                        description: >-
                          Extra facts about the error when they help you fix it,
                          such as a limit and when it resets.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
components:
  schemas:
    UpdateJobReferralPartnerRequest:
      type: object
      properties:
        default_split_percentage:
          type:
            - number
            - 'null'
          description: >-
            New default percentage, or null to clear it. Omit to leave it
            unchanged.
        default_mode:
          type: string
          enum:
            - off_the_top
            - team_pool
          description: New default payment mode. Omit to leave it unchanged.
    JobReferralPartnerResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          $ref: '#/components/schemas/JobReferralPartner'
      required:
        - success
        - data
    JobReferralPartner:
      type: object
      properties:
        client_contact_id:
          type: string
          format: uuid
          description: >-
            Client contact UUID of the referral partner. Matches IDs from GET
            /v1/client-contacts.
        person_id:
          type:
            - string
            - 'null'
          format: uuid
          description: >-
            Person UUID behind the client contact. Use GET /v1/persons/{id} for
            contact details.
        name:
          type:
            - string
            - 'null'
          description: Partner's full name.
        title:
          type:
            - string
            - 'null'
          description: Partner's current job title.
        image_url:
          type:
            - string
            - 'null'
          description: Profile image URL.
        company_id:
          type:
            - string
            - 'null'
          format: uuid
          description: UUID of the client company the contact belongs to.
        company_name:
          type:
            - string
            - 'null'
          description: Name of the client company the contact belongs to.
        default_split_percentage:
          type:
            - number
            - 'null'
          description: >-
            Default percentage offered to this partner when a placement is
            logged on the job. More than 0 and at most 100, rounded to 2
            decimals. Null when no default is set.
        default_mode:
          type: string
          enum:
            - off_the_top
            - team_pool
          description: >-
            How the referral partner is paid on a placement. `off_the_top`: the
            percentage is taken from the full placement fee before the team is
            credited. `team_pool`: the partner shares the team commission pool
            with the team members.
        created_at:
          type: string
          description: ISO 8601 timestamp when the partner was added to the job.
      required:
        - client_contact_id
        - person_id
        - name
        - title
        - image_url
        - company_id
        - company_name
        - default_split_percentage
        - default_mode
        - created_at
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Authenticate with a Bearer token: API key, OAuth token, or session
        token.

````

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