Five9

App · 20 actions

Run your Five9 contact centre from workflows: add contacts to dialing lists and call them right away, start and stop campaigns, manage the do-not-call list and agents' skills, and run reports. Start a workflow for each new call in a report, when a campaign starts or stops, or when a user is added.

Actions

ActionWhat it does
Add list to campaignMake an outbound or autodial campaign dial a dialing list too.
Add or update contactSave a contact in Five9: update the one that matches, or add a new one.
Add record to dialing listAdd a contact to a dialing list, saving them as a contact too, so the campaigns using the list call them: in turn, right away or at a set time.
Add to do-not-call listAdd phone numbers to your Five9 do-not-call list, so no campaign calls them.
Check do-not-call listCheck which phone numbers are on your Five9 do-not-call list.
Create dialing listCreate an empty dialing list.
Delete contactDelete a contact from Five9's contacts.
Delete dialing listDelete a dialing list.
Find contactsFind contacts in Five9 by phone number, name, email or any other field, with every field of each.
Get campaignGet one campaign: its type, description and whether it is running.
Give or remove skillGive an agent a skill, so they get its calls, or take it away.
List campaignsList your campaigns with their type (outbound, autodial or inbound) and whether each is running.
List dialing listsList your dialing lists and how many records each holds.
List usersList the people in your Five9 account with their username, extension and whether they are active.
Remove from do-not-call listTake phone numbers off your Five9 do-not-call list, so campaigns may call them again.
Remove list from campaignStop a campaign dialing a dialing list.
Remove record from dialing listTake a contact off a dialing list, so it isn't called from that list again.
Run reportRun one of your saved Five9 reports, such as a call log, for a period and get its rows.
Start campaignStart a campaign, so it begins dialing its lists (outbound) or taking calls (inbound).
Stop campaignStop a running campaign.

Add list to campaign

Make an outbound or autodial campaign dial a dialing list too. Nothing is sent if it already uses the list.

Inputs

CampaigncampaigntextRequired
The campaign. Pick one, or give its name from an earlier step.
Dialing listlist_nametextRequired
The dialing list. Pick one, or give its name from an earlier step.

Outputs

campaigntext
The campaign
changedtrue/false
False if it was already that way, so nothing was sent
listslist
The dialing lists the campaign uses now
Example output
{
  "campaign": "Spring renewals",
  "changed": true,
  "lists": [
    "Spring renewals list"
  ]
}

Add or update contact

Save a contact in Five9: update the one that matches, or add a new one. Only the fields filled in change.

Inputs

Contact fieldsfieldsobjectRequired
The contact's details, such as number1 (the phone number to dial), first_name and last_name. Fill in only what you have; empty fields keep their value.
Match contacts onmatch_onlist
The fields that identify the contact, so an existing one is updated rather than added twice. Defaults to number1.
What to domodetext
Update the match or add a contact, only update, or only add. A contact is updated only when exactly one matches.One of: add_or_update (Update the matching contact, or add one (default)), update_only (Only update a matching contact), add_only (Only add a new contact). Default: add_or_update.

Outputs

addedtrue/false
True if a contact was added
updatedtrue/false
True if a contact was updated
warningslist
Anything Five9 noted about the contact
Example output
{
  "added": true,
  "updated": false,
  "warnings": []
}

Add record to dialing list

Add a contact to a dialing list, saving them as a contact too, so the campaigns using the list call them: in turn, right away or at a set time.

Inputs

Dialing listlist_nametextRequired
The dialing list. Pick one, or give its name from an earlier step.
Contact fieldsfieldsobjectRequired
The contact's details, such as number1 (the phone number to dial), first_name and last_name. Fill in only what you have; empty fields keep their value.
Match contacts onmatch_onlist
The fields that identify the contact, so an existing one is updated rather than added twice. Defaults to number1.
When to calldialtext
In turn waits for the campaign to reach the record; right away puts it first. Defaults to in turn.One of: in_turn (In turn, when the campaign reaches it (default)), now (Right away), at_time (At a set time). Default: in_turn.
Call atdial_atdate and time
When to call the record.Only when When to call is At a set time.

Outputs

call_now_queuednumber
Records queued to be dialed right away or at a set time
crm_records_deletednumber
Contacts deleted
crm_records_insertednumber
Contacts added
crm_records_updatednumber
Contacts updated
list_nametext
The dialing list
list_records_deletednumber
Records removed from the list
list_records_insertednumber
Records added to the list
warningslist
Anything Five9 noted about the record
Example output
{
  "call_now_queued": 0,
  "crm_records_deleted": 0,
  "crm_records_inserted": 1,
  "crm_records_updated": 0,
  "list_name": "Spring renewals list",
  "list_records_deleted": 0,
  "list_records_inserted": 1,
  "warnings": []
}

Add to do-not-call list

Add phone numbers to your Five9 do-not-call list, so no campaign calls them.

Inputs

Phone numbersnumberslistRequired
Phone numbers such as 4155550123, one per entry or separated by commas.

Outputs

countnumber
How many numbers Five9 changed
numberslist
The numbers sent, as digits
Example output
{
  "count": 1,
  "numbers": [
    "4155550123"
  ]
}

Check do-not-call list

Check which phone numbers are on your Five9 do-not-call list.

Inputs

Phone numbersnumberslistRequired
Phone numbers such as 4155550123, one per entry or separated by commas.

Outputs

any_on_listtrue/false
True if any number is on the list
not_on_listlist
The numbers not on it
on_listlist
The numbers on the list
Example output
{
  "any_on_list": true,
  "not_on_list": [
    "4155550199"
  ],
  "on_list": [
    "4155550123"
  ]
}

Create dialing list

Create an empty dialing list. Add records to it, then add it to a campaign to dial them.

Inputs

Namelist_nametextRequired
The new list's name, which must not be in use.

Outputs

listobject
The new list
Example output
{
  "list": {
    "name": "Webinar sign-ups",
    "size": 0
  }
}

Delete contact

Delete a contact from Five9's contacts. Exactly one contact must match, or nothing is deleted.

Inputs

Find bymatchobjectRequired
The values to look for, such as number1 or email. A contact must match every field filled in.

Outputs

deletednumber
How many contacts were deleted
warningslist
Anything Five9 noted
Example output
{
  "deleted": 1,
  "warnings": []
}

Delete dialing list

Delete a dialing list. Its contacts stay in Five9; remove the list from every campaign first.

Inputs

Dialing listlist_nametextRequired
The dialing list. Pick one, or give its name from an earlier step.

Outputs

deletedtrue/false
Always true once done
list_nametext
The list deleted
Example output
{
  "deleted": true,
  "list_name": "Webinar sign-ups"
}

Find contacts

Find contacts in Five9 by phone number, name, email or any other field, with every field of each.

Inputs

Find bymatchobjectRequired
The values to look for, such as number1 or email. A contact must match every field filled in.

Outputs

contactslist
The contacts found
countnumber
How many
Example output
{
  "contacts": [
    {
      "email": "ana@example.com",
      "first_name": "Ana",
      "last_name": "Lopez",
      "number1": "4155550123"
    }
  ],
  "count": 1
}

Get campaign

Get one campaign: its type, description and whether it is running.

Inputs

CampaigncampaigntextRequired
The campaign. Pick one, or give its name from an earlier step.

Outputs

campaignobject
The campaign
Example output
{
  "campaign": {
    "description": "Customers whose plan renews this month",
    "mode": "BASIC",
    "name": "Spring renewals",
    "profile_name": "",
    "state": "RUNNING",
    "training_mode": false,
    "type": "OUTBOUND"
  }
}

Give or remove skill

Give an agent a skill, so they get its calls, or take it away.

Inputs

Useruser_nametextRequired
The agent. Pick one, or give their username.
SkillskilltextRequired
The skill. Pick one, or give its name.
Give or removechangetextRequired
Give the skill, or take it away.One of: add (Give the skill), remove (Take the skill away).
Skill levellevelnumber
The agent's level in the skill when giving it; 1 is offered calls first. Defaults to 1.Only when Give or remove is Give the skill. From 1 to 100.

Outputs

has_skilltrue/false
True if the agent has the skill now
levelnumber
The level sent
skilltext
The skill
user_nametext
The agent
Example output
{
  "has_skill": true,
  "level": 1,
  "skill": "Billing",
  "user_name": "jo.agent@example.com"
}

List campaigns

List your campaigns with their type (outbound, autodial or inbound) and whether each is running.

Inputs

Typecampaign_typetext
Only campaigns of this type. Leave empty for all.One of: OUTBOUND, AUTODIAL, INBOUND.
Statestatetext
Only campaigns in this state. Leave empty for all.One of: RUNNING, NOT_RUNNING (Not running), STARTING, STOPPING, RESETTING.
Name containssearchtext
Only those whose name contains this text.

Outputs

campaignslist
The campaigns
countnumber
How many
Example output
{
  "campaigns": [
    {
      "description": "Customers whose plan renews this month",
      "mode": "BASIC",
      "name": "Spring renewals",
      "profile_name": "",
      "state": "RUNNING",
      "training_mode": false,
      "type": "OUTBOUND"
    }
  ],
  "count": 1
}

List dialing lists

List your dialing lists and how many records each holds.

Inputs

Name containssearchtext
Only those whose name contains this text.

Outputs

countnumber
How many
listslist
The dialing lists
Example output
{
  "count": 1,
  "lists": [
    {
      "name": "Spring renewals list",
      "size": 1250
    }
  ]
}

List users

List the people in your Five9 account with their username, extension and whether they are active.

Inputs

Statusstatustext
Only active or only inactive users. Leave empty for all.One of: active (Active only), inactive (Inactive only).
Searchsearchtext
Only users whose username, name, email or extension contains this.

Outputs

countnumber
How many
userslist
The users
Example output
{
  "count": 1,
  "users": [
    {
      "active": true,
      "email": "jo.agent@example.com",
      "extension": "1042",
      "first_name": "Jo",
      "full_name": "Jo Agent",
      "id": "300000000000123",
      "last_name": "Agent",
      "locale": "en-US",
      "phone_number": "",
      "start_date": "2026-03-02T00:00:00.000-08:00",
      "user_name": "jo.agent@example.com",
      "user_profile": "Sales agents"
    }
  ]
}

Remove from do-not-call list

Take phone numbers off your Five9 do-not-call list, so campaigns may call them again.

Inputs

Phone numbersnumberslistRequired
Phone numbers such as 4155550123, one per entry or separated by commas.

Outputs

countnumber
How many numbers Five9 changed
numberslist
The numbers sent, as digits
Example output
{
  "count": 1,
  "numbers": [
    "4155550123"
  ]
}

Remove list from campaign

Stop a campaign dialing a dialing list. The list and its records stay in Five9.

Inputs

CampaigncampaigntextRequired
The campaign. Pick one, or give its name from an earlier step.
Dialing listlist_nametextRequired
The dialing list. Pick one, or give its name from an earlier step.

Outputs

campaigntext
The campaign
changedtrue/false
False if it was already that way, so nothing was sent
listslist
The dialing lists the campaign uses now
Example output
{
  "campaign": "Spring renewals",
  "changed": true,
  "lists": []
}

Remove record from dialing list

Take a contact off a dialing list, so it isn't called from that list again. The contact stays in Five9.

Inputs

Dialing listlist_nametextRequired
The dialing list. Pick one, or give its name from an earlier step.
Find byfieldsobjectRequired
The fields that identify the contact, such as number1. Exactly one contact must match.

Outputs

call_now_queuednumber
Records queued to be dialed right away or at a set time
crm_records_deletednumber
Contacts deleted
crm_records_insertednumber
Contacts added
crm_records_updatednumber
Contacts updated
list_nametext
The dialing list
list_records_deletednumber
Records removed from the list
list_records_insertednumber
Records added to the list
warningslist
Anything Five9 noted about the record
Example output
{
  "call_now_queued": 0,
  "crm_records_deleted": 0,
  "crm_records_inserted": 0,
  "crm_records_updated": 0,
  "list_name": "Spring renewals list",
  "list_records_deleted": 1,
  "list_records_inserted": 0,
  "warnings": []
}

Run report

Run one of your saved Five9 reports, such as a call log, for a period and get its rows. Takes up to a minute.

Inputs

FolderfoldertextRequired
The folder the report is saved in, as Five9's reports page shows it.
ReportreporttextRequired
The report's name, exactly as Five9 shows it.
Fromstartdate and time
The start of the period. Defaults to 24 hours ago.
Toenddate and time
The end of the period. Defaults to now.

Outputs

columnslist
The report's columns, in order
countnumber
How many
report_idtext
Five9's ID for this run
rowslist
The rows
Example output
{
  "columns": [
    "CALL ID",
    "TIMESTAMP",
    "CAMPAIGN",
    "DISPOSITION"
  ],
  "count": 1,
  "report_id": "6E3D9C3B0A2F4B1E",
  "rows": [
    {
      "CALL ID": "300000001234567",
      "CAMPAIGN": "Spring renewals",
      "DISPOSITION": "Sale",
      "TIMESTAMP": "Tue, 17 Nov 2026 09:14:02"
    }
  ]
}

Start campaign

Start a campaign, so it begins dialing its lists (outbound) or taking calls (inbound). Nothing is sent if it is already running.

Inputs

CampaigncampaigntextRequired
The campaign. Pick one, or give its name from an earlier step.

Outputs

campaigntext
The campaign
changedtrue/false
False if it was already that way, so nothing was sent
statetext
Its state now, such as RUNNING
Example output
{
  "campaign": "Spring renewals",
  "changed": true,
  "state": "RUNNING"
}

Stop campaign

Stop a running campaign. Nothing is sent if it is already stopped.

Inputs

CampaigncampaigntextRequired
The campaign. Pick one, or give its name from an earlier step.

Outputs

campaigntext
The campaign
changedtrue/false
False if it was already that way, so nothing was sent
statetext
Its state now, such as RUNNING
Example output
{
  "campaign": "Spring renewals",
  "changed": true,
  "state": "NOT_RUNNING"
}

On this page