> ## 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 outreach gross profit config

> Sets (or clears) the Contact property used to calculate gross profit for outreach ROI. Body { entityType: "Contact", propertyKey: string }; sending null or an empty object clears the config. Admin-only (own org for Admin; any org for SuperAdmin).



## OpenAPI

````yaml /api-reference/openapi.yaml put /api/organizations/{organizationId}/outreach-gross-profit-config
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/organizations/{organizationId}/outreach-gross-profit-config:
    put:
      tags:
        - Organizations
      summary: Update outreach gross profit config
      description: >-
        Sets (or clears) the Contact property used to calculate gross profit for
        outreach ROI. Body { entityType: "Contact", propertyKey: string };
        sending null or an empty object clears the config. Admin-only (own org
        for Admin; any org for SuperAdmin).
      operationId: put_organizations_organizationId_outreach_gross_profit_config
      parameters:
        - in: path
          name: organizationId
          required: true
          schema:
            type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOutreachGrossProfitConfigRequest'
      responses:
        '200':
          description: Gross profit config updated or cleared
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutreachGrossProfitConfigResponse'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationStatusErrorResponse'
        '403':
          description: Admin access required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationStatusErrorResponse'
        '500':
          description: Error updating gross profit config
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationStatusErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    UpdateOutreachGrossProfitConfigRequest:
      type: object
      description: >-
        Pass null or {} to clear the config; otherwise must include
        entityType="Contact" and a non-empty propertyKey.
      properties:
        entityType:
          type: string
          enum:
            - Contact
          description: >-
            Entity holding the gross-profit value; currently only `Contact` is
            supported.
        propertyKey:
          type: string
          description: >-
            Dynamic-property key on the entity whose numeric value is summed for
            outreach ROI calculation.
      nullable: true
      additionalProperties: true
      example:
        entityType: Contact
        propertyKey: loanGrossProfit
    OutreachGrossProfitConfigResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/OutreachGrossProfitConfig'
      additionalProperties: true
      example:
        success: true
        data:
          entityType: Contact
          propertyKey: loanGrossProfit
    OrganizationStatusErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        message:
          type: string
      additionalProperties: true
      example:
        success: false
        message: Access denied
    OutreachGrossProfitConfig:
      type: object
      properties:
        entityType:
          type: string
          enum:
            - Contact
        propertyKey:
          type: string
      required:
        - entityType
        - propertyKey
      additionalProperties: true
      example:
        entityType: Contact
        propertyKey: loanGrossProfit
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````