/lead-sources

POST /lead-sources

Create a new lead source

Create a new lead source with the provided data

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Required Parameters

x-account-id header string

Account ID for the request

Request Body

Minimum Required
All Properties

{
  "name": "string"
}

{
  "name": "string",
  "active": true
}

Try it out

Output:

Responses

Description

Lead source created successfully

{
  "id": 0,
  "name": "string",
  "accountId": "string",
  "active": true,
  "createdBy": "string",
  "updatedBy": "string",
  "createdAt": "string",
  "updatedAt": "string"
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/LeadSourceInput #/components/schemas/LeadSource

in: header
name: x-account-id
schema:
  type: string
description: Account ID for the request
required: true
example: "2311"

|
export type xAccountIdHeader = any; // Schema type not fully supported

#/components/schemas/LeadSourceInput

OpenAPI
TypeScript

type: object
description: Input for creating a new lead source
properties:
  name:
    type: string
    description: Name of the lead source
  active:
    type: boolean
    default: true
    description: Whether the lead source is active
required:
  - name

|
export interface LeadSourceInput {
  /** Name of the lead source */
  name: string;
  /** Whether the lead source is active */
  active?: boolean;
}

#/components/schemas/LeadSource

OpenAPI
TypeScript

type: object
description: Lead source object representing a channel through which leads are acquired
properties:
  id:
    type: integer
    description: Unique identifier for the lead source
  name:
    type: string
    description: Name of the lead source
  accountId:
    type: string
    description: ID of the account that owns this lead source
  active:
    type: boolean
    default: true
    description: Whether the lead source is active
  createdBy:
    type: string
    description: Email of the user who created the lead source
  updatedBy:
    type: string
    description: Email of the user who last updated the lead source
  createdAt:
    type: string
    format: date-time
    description: When the lead source was created
  updatedAt:
    type: string
    format: date-time
    description: When the lead source was last updated
required:
  - id
  - name
  - accountId

|
export interface LeadSource {
  /** Unique identifier for the lead source */
  id: number;
  /** Name of the lead source */
  name: string;
  /** ID of the account that owns this lead source */
  accountId: string;
  /** Whether the lead source is active */
  active?: boolean;
  /** Email of the user who created the lead source */
  createdBy?: string;
  /** Email of the user who last updated the lead source */
  updatedBy?: string;
  /** When the lead source was created */
  createdAt?: Date;
  /** When the lead source was last updated */
  updatedAt?: Date;
}

Route Source Code

Check out the source code for this route entrypoint here: /lead-sources/route.ts

Or the swagger.yaml spec this documentation was generated from: /lead-sources/swagger.yaml