API Documentation

Authentication

To authenticate generate a new API Token in your profile, and pass it in the Authorization header as a Bearer token

Authorization: Bearer {yourToken}

Agents Collection

Method: GET

This endpoint returns a list of all Agents in your account in alphabetical order.

Endpoint

https://app.salescloser.ai/api/v2/agents

Example Response

[
  {
    "id": 1,
    "name": "My New Product Showcase"
  },
  {
    "id": 2,
    "name": "My New Course Demo"
  },
  ...
]

Agent States Collection

Method: GET

This endpoint returns a list of all States that belong to an Agent in your account.

Endpoint

https://app.salescloser.ai/api/v2/agents/{agentId}

Example Response

[
  {
    "id": 1,
    "name": "step_1",
  },
  {
    "id": 2,
    "name": "step_2"
  },
  {
    "id": 3,
    "name": "step_3"
  },
  {
    "id": 4,
    "name": "step_4"
  },
  ...
]

Create Campaign

Method: POST

This endpoint creates a Campaign with status DRAFT

Endpoint

https://app.salescloser.ai/api/v2/campaigns

Request Fields

agent_id (required) - Integer

Has to be attached to a Phone Number
title (required) - String

Max length: 255 characters
scheduled_at (required) - DateTime

Has to be in the UTC timezone

Format: "Y-m-d H:i:s" 2025-07-11 10:33:31
leads (required) - array

Has to include at least one lead object with the following fields
- email (optional) - Valid Email
- business_name (optional) - String
- first_name (optional) - String
- last_name (optional) - String
- phone_number (required) - Valid Phone Number
- website_url (optional) - String
- You can pass any other properties to the Lead as long as the value is a String.

Example Response

{
    "id": 1000,
    "title": "My First Campaign",
    "status": "draft",
    "scheduled_at": "2024-04-02T20:32:53.000000Z"
}

Update Campaign

Method: PATCH

This endpoint updates a Campaign

Endpoint

https://app.salescloser.ai/api/v2/campaigns/{campaignId}

Request Fields

title (required) - String

Max length: 255 characters
scheduled_at (required) - DateTime

Has to be in the UTC timezone

Format: "Y-m-d H:i:s" 2025-07-11 10:33:31
Valid options: draft, live.

Example Response

{
    "id": 1000,
    "title": "My First Campaign",
    "status": "live",
    "scheduled_at": "2024-04-02T20:32:53.000000Z"
}

Calls Collection

Method: GET

This endpoint returns a paginated list of all Calls in your account.

Endpoint

https://app.salescloser.ai/api/v2/calls

Query Fields

status (optional) - String

Valid options: completed, in_progress, incomplete, draft, scheduled, sent_to_server, pending.
type (optional) - String

Valid options: inbound_call, outbound_call, zoom.
agent_id (optional) - Integer

A valid Agent ID
campaign_id (optional) - Integer

A valid Campaign ID
lead_id (optional) - Integer

A valid Lead ID
order_by (optional) - String

Defaults to id.

Valid options: id scheduled_at, finished_at.
order_direction (optional) - String

Defaults to DESC.

Valid options: ASC, DESC.
per_page (optional) - Integer

Defaults to 24.
page (optional) - String

Defaults to 1.

Example Response

{
  "data": [
    {
      "id": 1000,
      "agent_id": 123,
      "lead_id": 123,
      "campaign_id": null,
      "finished_demo_at": null,
      "status": "pending",
      "final_step_reached": null,
      "next_steps": null,
      "summary_background": null,
      "provider_meeting_id": null,
      "minutes": null,
      "retries": 0,
      "incomplete_reason": null,
      "sent_to_server_at": null,
      "created_at": "2024-04-02T20:32:53.000000Z",
      "updated_at": "2024-05-06T20:40:37.000000Z",
      "scheduled_at": null,
      "type": "zoom"
    },
    ...
  ],
  "metadata": {
    "current_page": 1,
    "total_records": 80,
    "has_more_pages": true,
    "total_pages": 4
  }
}

Create Call

Method: POST

This endpoint creates a Call.

Endpoint

https://app.salescloser.ai/api/v2/calls

Request Fields

agent_id (required) - Integer

Has to be attached to a Phone Number
scheduled_at (required) - DateTime

Has to be in the UTC timezone

Format: "Y-m-d H:i:s" 2025-07-11 10:33:31
lead (required) - Object
- email (optional) - Valid Email
- business_name (optional) - String
- first_name (optional) - String
- last_name (optional) - String
- phone_number (required) - Valid Phone Number
- website_url (optional) - String
- You can pass any other properties to the Lead as long as the value is a String.

Example Response

{
  "data": {
    "demo": {
      "id": 1235,
      "agent_id": 122,
      "lead_id": 489,
      "campaign_id": null,
      "finished_demo_at": null,
      "status": "draft",
      "final_step_reached": null,
      "next_steps": null,
      "summary_background": null,
      "provider_meeting_id": null,
      "minutes": null,
      "retries": 0,
      "incomplete_reason": null,
      "sent_to_server_at": null,
      "created_at": "2024-07-10T19:54:37.000000Z",
      "updated_at": "2024-07-10T19:54:37.000000Z",
      "scheduled_at": "2024-09-01T12:00:00.000000Z",
      "type": "outbound_phone"
    }
  },
  "message": "Call created successfully"
}

These are the timezones you can use for your leads and campaigns. When uploading timezones via a CSV file, make sure the format strictly follows standard IANA timezone names. Incorrect formatting may result in scheduling issues.

✅ Accepted Format:

America/New_York
Asia/Karachi
Europe/London

❌ Not Accepted:

GMT
UTC+5
america/new_york
New York

Timezones are case-sensitive and must exactly match standard IANA formats. Informal or incorrect names will lead to campaign or lead scheduling errors.

🌍 Full List of Supported Timezones

Africa/Abidjan Africa/Accra Africa/Addis_Ababa Africa/Algiers Africa/Asmara Africa/Bamako Africa/Bangui Africa/Banjul Africa/Bissau Africa/Blantyre Africa/Brazzaville Africa/Bujumbura Africa/Cairo Africa/Casablanca Africa/Ceuta Africa/Conakry Africa/Dakar Africa/Dar_es_Salaam Africa/Djibouti Africa/Douala Africa/El_Aaiun Africa/Freetown Africa/Gaborone Africa/Harare Africa/Johannesburg Africa/Juba Africa/Kampala Africa/Khartoum Africa/Kigali Africa/Kinshasa Africa/Lagos Africa/Libreville Africa/Lome Africa/Luanda Africa/Lubumbashi Africa/Lusaka Africa/Malabo Africa/Maputo Africa/Maseru Africa/Mbabane Africa/Mogadishu Africa/Monrovia Africa/Nairobi Africa/Ndjamena Africa/Niamey Africa/Nouakchott Africa/Ouagadougou Africa/Porto-Novo Africa/Sao_Tome Africa/Tripoli Africa/Tunis Africa/Windhoek America/Adak America/Anchorage America/Anguilla America/Antigua America/Araguaina America/Argentina/Buenos_Aires America/Argentina/Catamarca America/Argentina/Cordoba America/Argentina/Jujuy America/Argentina/La_Rioja America/Argentina/Mendoza America/Argentina/Rio_Gallegos America/Argentina/Salta America/Argentina/San_Juan America/Argentina/San_Luis America/Argentina/Tucuman America/Argentina/Ushuaia America/Aruba America/Asuncion America/Atikokan America/Bahia America/Bahia_Banderas America/Barbados America/Belem America/Belize America/Blanc-Sablon America/Boa_Vista America/Bogota America/Boise America/Cambridge_Bay America/Campo_Grande America/Cancun America/Caracas America/Cayenne America/Cayman America/Chicago America/Chihuahua America/Costa_Rica America/Creston America/Cuiaba America/Curacao America/Danmarkshavn America/Dawson America/Dawson_Creek America/Denver America/Detroit America/Dominica America/Edmonton America/Eirunepe America/El_Salvador America/Fort_Nelson America/Fortaleza America/Glace_Bay America/Goose_Bay America/Grand_Turk America/Grenada America/Guadeloupe America/Guatemala America/Guayaquil America/Guyana America/Halifax America/Havana America/Hermosillo America/Indiana/Indianapolis America/Indiana/Knox America/Indiana/Marengo America/Indiana/Petersburg America/Indiana/Tell_City America/Indiana/Vevay America/Indiana/Vincennes America/Indiana/Winamac America/Inuvik America/Iqaluit America/Jamaica America/Juneau America/Kentucky/Louisville America/Kentucky/Monticello America/Kralendijk America/La_Paz America/Lima America/Los_Angeles America/Lower_Princes America/Maceio America/Managua America/Manaus America/Marigot America/Martinique America/Matamoros America/Mazatlan America/Menominee America/Merida America/Metlakatla America/Mexico_City America/Miquelon America/Moncton America/Monterrey America/Montevideo America/Montserrat America/Nassau America/New_York America/Nipigon America/Nome America/Noronha America/North_Dakota/Beulah America/North_Dakota/Center America/North_Dakota/New_Salem America/Nuuk America/Ojinaga America/Panama America/Pangnirtung America/Paramaribo America/Phoenix America/Port-au-Prince America/Port_of_Spain America/Porto_Velho America/Puerto_Rico America/Punta_Arenas America/Rainy_River America/Rankin_Inlet America/Recife America/Regina America/Resolute America/Rio_Branco America/Santarem America/Santiago America/Santo_Domingo America/Sao_Paulo America/Scoresbysund America/Sitka America/St_Barthelemy America/St_Johns America/St_Kitts America/St_Lucia America/St_Thomas America/St_Vincent America/Swift_Current America/Tegucigalpa America/Thule America/Thunder_Bay America/Tijuana America/Toronto America/Tortola America/Vancouver America/Whitehorse America/Winnipeg America/Yakutat America/Yellowknife Antarctica/Casey Antarctica/Davis Antarctica/DumontDUrville Antarctica/Macquarie Antarctica/Mawson Antarctica/McMurdo Antarctica/Palmer Antarctica/Rothera Antarctica/Syowa Antarctica/Troll Antarctica/Vostok Arctic/Longyearbyen Asia/Aden Asia/Almaty Asia/Amman Asia/Anadyr Asia/Aqtau Asia/Aqtobe Asia/Ashgabat Asia/Atyrau Asia/Baghdad Asia/Bahrain Asia/Baku Asia/Bangkok Asia/Barnaul Asia/Beirut Asia/Bishkek Asia/Brunei Asia/Chita Asia/Choibalsan Asia/Colombo Asia/Damascus Asia/Dhaka Asia/Dili Asia/Dubai Asia/Dushanbe Asia/Famagusta Asia/Gaza Asia/Hebron Asia/Ho_Chi_Minh Asia/Hong_Kong Asia/Hovd Asia/Irkutsk Asia/Istanbul Asia/Jakarta Asia/Jayapura Asia/Jerusalem Asia/Kabul Asia/Kamchatka Asia/Karachi Asia/Kathmandu Asia/Khandyga Asia/Kolkata Asia/Krasnoyarsk Asia/Kuala_Lumpur Asia/Kuching Asia/Kuwait Asia/Macau Asia/Magadan Asia/Makassar Asia/Manila Asia/Muscat Asia/Nicosia Asia/Novokuznetsk Asia/Novosibirsk Asia/Omsk Asia/Oral Asia/Phnom_Penh Asia/Pontianak Asia/Pyongyang Asia/Qatar Asia/Qostanay Asia/Qyzylorda Asia/Riyadh Asia/Sakhalin Asia/Samarkand Asia/Seoul Asia/Shanghai Asia/Singapore Asia/Srednekolymsk Asia/Taipei Asia/Tashkent Asia/Tbilisi Asia/Tehran Asia/Thimphu Asia/Tokyo Asia/Tomsk Asia/Turkey Asia/Ulaanbaatar Asia/Urumqi Asia/Ust-Nera Asia/Vientiane Asia/Vladivostok Asia/Yakutsk Asia/Yangon Asia/Yekaterinburg Asia/Yerevan Atlantic/Azores Atlantic/Bermuda Atlantic/Canary Atlantic/Cape_Verde Atlantic/Faroe Atlantic/Madeira Atlantic/Reykjavik Atlantic/South_Georgia Atlantic/St_Helena Atlantic/Stanley Australia/Adelaide Australia/Brisbane Australia/Broken_Hill Australia/Darwin Australia/Eucla Australia/Hobart Australia/Lindeman Australia/Lord_Howe Australia/Melbourne Australia/Perth Australia/Sydney Europe/Amsterdam Europe/Andorra Europe/Astrakhan Europe/Athens Europe/Belgrade Europe/Berlin Europe/Bratislava Europe/Brussels Europe/Bucharest Europe/Budapest Europe/Busingen Europe/Chisinau Europe/Copenhagen Europe/Dublin Europe/Gibraltar Europe/Guernsey Europe/Helsinki Europe/Isle_of_Man Europe/Istanbul Europe/Jersey Europe/Kaliningrad Europe/Kiev Europe/Kirov Europe/Lisbon Europe/Ljubljana Europe/London Europe/Luxembourg Europe/Madrid Europe/Malta Europe/Mariehamn Europe/Minsk Europe/Monaco Europe/Moscow Europe/Oslo Europe/Paris Europe/Podgorica Europe/Prague Europe/Riga Europe/Rome Europe/Samara Europe/San_Marino Europe/Sarajevo Europe/Saratov Europe/Simferopol Europe/Skopje Europe/Sofia Europe/Stockholm Europe/Tallinn Europe/Tirane Europe/Ulyanovsk Europe/Uzhgorod Europe/Vaduz Europe/Vatican Europe/Vienna Europe/Vilnius Europe/Volgograd Europe/Warsaw Europe/Zagreb Europe/Zaporozhye Europe/Zurich Indian/Antananarivo Indian/Chagos Indian/Christmas Indian/Cocos Indian/Comoro Indian/Kerguelen Indian/Mahe Indian/Maldives Indian/Mauritius Indian/Mayotte Indian/Reunion Pacific/Apia Pacific/Auckland Pacific/Bougainville Pacific/Chatham Pacific/Chuuk Pacific/Easter Pacific/Efate Pacific/Enderbury Pacific/Fakaofo Pacific/Fiji Pacific/Funafuti Pacific/Galapagos Pacific/Gambier Pacific/Guadalcanal Pacific/Guam Pacific/Honolulu Pacific/Kiritimati Pacific/Kosrae Pacific/Kwajalein Pacific/Majuro Pacific/Marquesas Pacific/Midway Pacific/Nauru Pacific/Niue Pacific/Norfolk Pacific/Noumea Pacific/Pago_Pago Pacific/Palau Pacific/Pitcairn Pacific/Pohnpei Pacific/Port_Moresby Pacific/Rarotonga Pacific/Saipan Pacific/Tahiti Pacific/Tarawa Pacific/Tongatapu Pacific/Wake Pacific/Wallis