OUoutcallerai
admin-leads

Create Lead

Changed on
post/api/admin/leads

Request

  • Base URL
    https://api.outcallerai.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.outcallerai.com/api/admin/leads
  • Auth
    none declared

Request body

workspace_idstring required
use_case_idstring nullable
agent_idstring nullable
namestring required
emailstring nullable
phonestring nullable
descriptionstring nullable
custom_fieldsobject nullable
sourcestring nullable
statusstring nullable
external_sourcestring nullable
external_refstring nullable

Response

Successful Response

idstring required
namestring required
emailstring nullable
phonestring nullable
workspace_idstring required
workspace_namestring required
use_case_idstring nullable
use_case_namestring nullable
use_case_typestring nullable
agent_idstring nullable
agent_namestring nullable
sourcestring nullable
statusstring nullable
descriptionstring nullable
external_sourcestring nullable
external_refstring nullable
synced_to_sheetboolean
captured_from_chatboolean
deleted_atstring date-time nullable
created_atstring date-time required
updated_atstring date-time required

Changes

  • 7c9aff2501f3Revision changes
    • breaking

      the request property's minLength was increased from 0 to 1

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status