Documentation

Set Default Outbound

Designate this configuration as the org-wide default for outbound calls

Designate this configuration as the org-wide default for outbound calls

Campaigns and ad-hoc calls that omit telephony_configuration_id use the default outbound configuration. Setting a new default automatically clears the previous one — at most one configuration can be the default at a time.

Quick reference#

Designate this configuration as the org-wide default for outbound calls. Send the request to POST /api/v1/organizations/telephony-configs/{configid}/set-default-outbound on the Paladin API base URL.

Method	`POST`
Path	`/api/v1/organizations/telephony-configs/{configid}/set-default-outbound`
Path parameters	configid
Authentication	Use the authentication method shown in the OpenAPI block and the Authentication docs. Keep API keys server-side.

Before you call#

Confirm you are using the production base URL shown in the API reference.
Make sure any path IDs belong to the same Paladin organization as the credential you are using.
Validate request bodies and required fields before sending production traffic.

Common error checks#

Use 401 or 403 responses to check credentials, organization scope, and permissions.
Use 404 responses to check whether the referenced resource exists in the current organization.
Use 422 responses to inspect missing or invalid request fields.

OpenAPI#

POST /api/v1/organizations/telephony-configs/{configid}/set-default-outbound

openapi: 3.1.0
info:
  title: Paladin API
  description: API for the Paladin app
  version: 1.0.0
servers:
  - url: https://app.paladin.northmanngrp.com
    description: Production

security: []
paths:
  /api/v1/organizations/telephony-configs/{config_id}/set-default-outbound:
    post:
      tags:
        - main
        - organizations
      summary: Set Default Outbound
      operationId: >-
        set_default_outbound_api_v1_organizations_telephony_configs__config_id__set_default_outbound_post
      parameters:
        - name: config_id
          in: path
          required: true
          schema:
            type: integer
            title: Config Id
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TelephonyConfigurationDetail'
        '404':
          description: Not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    TelephonyConfigurationDetail:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        provider:
          type: string
          title: Provider
        is_default_outbound:
          type: boolean
          title: Is Default Outbound
        credentials:
          additionalProperties: true
          type: object
          title: Credentials
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
        - id
        - name
        - provider
        - is_default_outbound
        - credentials
        - created_at
        - updated_at
      title: TelephonyConfigurationDetail
      description: Body of ``GET /telephony-configs/{id}`` — credentials are masked.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError