genesys-outbound - Pinkfish - AI Agents & Workflows for Getting Work Done

Server path: /genesys-outbound | Type: Application | PCID required: Yes

Tools

Tool	Description
`genesys-outbound_delete_attemptlimit`	Delete attempt limits
`genesys-outbound_delete_callabletimeset`	Delete callable time set
`genesys-outbound_delete_callanalysisresponseset`	Delete a dialer call analysis response set.
`genesys-outbound_delete_campaign`	Delete a campaign.
`genesys-outbound_delete_campaign_progress`	Reset campaign progress and recycle the campaign
`genesys-outbound_delete_campaignrule`	Delete Campaign Rule
`genesys-outbound_delete_contactlist`	Delete a contact list.
`genesys-outbound_delete_contactlist_contact`	Delete a contact.
`genesys-outbound_delete_contactlist_contacts`	Delete contacts from a contact list. Only contacts that are not in use by any campaign will be deleted
`genesys-outbound_delete_contactlistfilter`	Delete Contact List Filter
`genesys-outbound_delete_contactlists`	Delete multiple contact lists.
`genesys-outbound_delete_contactlisttemplate`	Delete Contact List Template
`genesys-outbound_delete_contactlisttemplates`	Delete multiple contact list templates.
`genesys-outbound_delete_digitalruleset`	Delete an Outbound Digital Rule Set
`genesys-outbound_delete_dnclist`	Delete dialer DNC list
`genesys-outbound_delete_dnclist_customexclusioncolumns`	Deletes all or expired custom exclusion column entries from a DNC list.
`genesys-outbound_delete_dnclist_emailaddresses`	Deletes all or expired email addresses from a DNC list.
`genesys-outbound_delete_dnclist_phonenumbers`	Deletes all or expired phone numbers from a DNC list.
`genesys-outbound_delete_dnclist_whatsappnumbers`	Deletes all or expired whatsApp numbers from a DNC list.
`genesys-outbound_delete_filespecificationtemplate`	Delete File Specification Template
`genesys-outbound_delete_filespecificationtemplates_bulk`	Delete multiple file specification templates.
`genesys-outbound_delete_importtemplate`	Delete Import Template
`genesys-outbound_delete_importtemplates`	Delete multiple import templates.
`genesys-outbound_delete_messagingcampaign`	Delete an Outbound Messaging Campaign
`genesys-outbound_delete_messagingcampaign_progress`	Reset messaging campaign progress and recycle the messaging campaign
`genesys-outbound_delete_ruleset`	Delete a Rule Set.
`genesys-outbound_delete_schedules_campaign`	Delete a dialer campaign schedule.
`genesys-outbound_delete_schedules_emailcampaign`	Delete an email campaign schedule.
`genesys-outbound_delete_schedules_messagingcampaign`	Delete a messaging campaign schedule.
`genesys-outbound_delete_schedules_sequence`	Delete a dialer sequence schedule.
`genesys-outbound_delete_schedules_whatsappcampaign`	Delete a WhatsApp campaign schedule.
`genesys-outbound_delete_sequence`	Delete a dialer campaign sequence.
`genesys-outbound_get_attemptlimit`	Get attempt limits
`genesys-outbound_get_attemptlimits`	Query attempt limits list
`genesys-outbound_get_callabletimeset`	Get callable time set
`genesys-outbound_get_callabletimesets`	Query callable time set list
`genesys-outbound_get_callanalysisresponseset`	Get a dialer call analysis response set.
`genesys-outbound_get_callanalysisresponsesets`	Query a list of dialer call analysis response sets.
`genesys-outbound_get_campaign`	Get dialer campaign.
`genesys-outbound_get_campaign_agentownedmappingpreview_results`	Get a preview of how agents will be mapped to this campaign’s contact list.
`genesys-outbound_get_campaign_diagnostics`	Get campaign diagnostics
`genesys-outbound_get_campaign_interactions`	Get dialer campaign interactions.
`genesys-outbound_get_campaign_linedistribution`	Get line distribution information for campaigns using same Edge Group or Site as given campaign
`genesys-outbound_get_campaign_progress`	Get campaign progress
`genesys-outbound_get_campaign_skillcombinations`	Get the remaining and total contact count for each skill combination in a skills campaign
`genesys-outbound_get_campaign_stats`	Get statistics about a Dialer Campaign
`genesys-outbound_get_campaignrule`	Get Campaign Rule
`genesys-outbound_get_campaignrules`	Query Campaign Rule list
`genesys-outbound_get_campaigns`	Query a list of dialer campaigns.
`genesys-outbound_get_campaigns_all`	Query across all types of campaigns by division
`genesys-outbound_get_campaigns_all_divisionviews`	Query across all types of campaigns
`genesys-outbound_get_campaigns_divisionview`	Get a basic Campaign information object
`genesys-outbound_get_campaigns_divisionviews`	Query a list of basic Campaign information objects
`genesys-outbound_get_contactlist`	Get a dialer contact list.
`genesys-outbound_get_contactlist_contact`	Get a contact.
`genesys-outbound_get_contactlist_contacts_bulk_job`	Get bulk operation job.
`genesys-outbound_get_contactlist_contacts_bulk_jobs`	Get 10 most recent bulk operation jobs associated with contact list.
`genesys-outbound_get_contactlist_export`	Get the URI of a contact list export.
`genesys-outbound_get_contactlist_importstatus`	Get dialer contactList import status.
`genesys-outbound_get_contactlist_timezonemappingpreview`	Preview the result of applying Automatic Time Zone Mapping to a contact list
`genesys-outbound_get_contactlistfilter`	Get Contact list filter
`genesys-outbound_get_contactlistfilters`	Query Contact list filters
`genesys-outbound_get_contactlists`	Query a list of contact lists.
`genesys-outbound_get_contactlists_divisionview`	Get a basic ContactList information object
`genesys-outbound_get_contactlists_divisionviews`	Query a list of simplified contact list objects.
`genesys-outbound_get_contactlisttemplate`	Get Contact List Template
`genesys-outbound_get_contactlisttemplates`	Query a list of contact list templates
`genesys-outbound_get_diagnostics_campaign_summary`	Get diagnostic summary for a single campaign
`genesys-outbound_get_digitalruleset`	Get an Outbound Digital Rule Set
`genesys-outbound_get_digitalrulesets`	Query a list of Outbound Digital Rule Sets
`genesys-outbound_get_dnclist`	Get dialer DNC list
`genesys-outbound_get_dnclist_export`	Get the URI of a DNC list export.
`genesys-outbound_get_dnclist_importstatus`	Get dialer dncList import status.
`genesys-outbound_get_dnclists`	Query dialer DNC lists
`genesys-outbound_get_dnclists_divisionview`	Get a basic DncList information object
`genesys-outbound_get_dnclists_divisionviews`	Query a list of simplified dnc list objects.
`genesys-outbound_get_event`	Get Dialer Event
`genesys-outbound_get_events`	Query Event Logs
`genesys-outbound_get_filespecificationtemplate`	Get File Specification Template
`genesys-outbound_get_filespecificationtemplates`	Query File Specification Templates
`genesys-outbound_get_importtemplate`	Get Import Template
`genesys-outbound_get_importtemplate_importstatus`	Get the import status for an import template.
`genesys-outbound_get_importtemplates`	Query Import Templates
`genesys-outbound_get_messagingcampaign`	Get an Outbound Messaging Campaign
`genesys-outbound_get_messagingcampaign_diagnostics`	Get messaging campaign diagnostics
`genesys-outbound_get_messagingcampaign_progress`	Get messaging campaign’s progress
`genesys-outbound_get_messagingcampaigns`	Query a list of Messaging Campaigns
`genesys-outbound_get_messagingcampaigns_divisionview`	Get a basic Messaging Campaign information object
`genesys-outbound_get_messagingcampaigns_divisionviews`	Query a list of basic Messaging Campaign information objects
`genesys-outbound_get_ruleset`	Get a Rule Set by ID.
`genesys-outbound_get_rulesets`	Query a list of Rule Sets.
`genesys-outbound_get_schedules_campaign`	Get a dialer campaign schedule.
`genesys-outbound_get_schedules_campaigns`	Query for a list of dialer campaign schedules.
`genesys-outbound_get_schedules_emailcampaign`	Get an email campaign schedule.
`genesys-outbound_get_schedules_emailcampaigns`	Query for a list of email campaign schedules.
`genesys-outbound_get_schedules_messagingcampaign`	Get a messaging campaign schedule.
`genesys-outbound_get_schedules_messagingcampaigns`	Query for a list of messaging campaign schedules.
`genesys-outbound_get_schedules_sequence`	Get a dialer sequence schedule.
`genesys-outbound_get_schedules_sequences`	Query for a list of dialer sequence schedules.
`genesys-outbound_get_schedules_whatsappcampaign`	Get a WhatsApp campaign schedule.
`genesys-outbound_get_schedules_whatsappcampaigns`	Query for a list of WhatsApp campaign schedules.
`genesys-outbound_get_sequence`	Get a dialer campaign sequence.
`genesys-outbound_get_sequences`	Query a list of dialer campaign sequences.
`genesys-outbound_get_settings`	Get the outbound settings for this organization
`genesys-outbound_get_wrapupcodemappings`	Get the Dialer wrap up code mapping.
`genesys-outbound_patch_campaign`	Update a campaign.
`genesys-outbound_patch_dnclist_customexclusioncolumns`	Add entries to or delete entries from a DNC list.
`genesys-outbound_patch_dnclist_emailaddresses`	Add emails to or Delete emails from a DNC list.
`genesys-outbound_patch_dnclist_phonenumbers`	Add numbers to or delete numbers from a DNC list.
`genesys-outbound_patch_dnclist_whatsappnumbers`	Add entries to or delete entries from a DNC list.
`genesys-outbound_patch_settings`	Update the outbound settings for this organization
`genesys-outbound_post_attemptlimits`	Create attempt limits
`genesys-outbound_post_callabletimesets`	Create callable time set
`genesys-outbound_post_callanalysisresponsesets`	Create a dialer call analysis response set.
`genesys-outbound_post_campaign_agentownedmappingpreview`	Initiate request for a preview of how agents will be mapped to this campaign’s contact list.
`genesys-outbound_post_campaign_start`	Start the campaign
`genesys-outbound_post_campaign_stop`	Stop the campaign
`genesys-outbound_post_campaignrules`	Create Campaign Rule
`genesys-outbound_post_campaigns`	Create a campaign.
`genesys-outbound_post_campaigns_performance_query`	Get performance data for a list of campaigns
`genesys-outbound_post_campaigns_progress`	Get progress for a list of campaigns
`genesys-outbound_post_contactlist_clear`	Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.
`genesys-outbound_post_contactlist_contacts`	Add contacts to a contact list.
`genesys-outbound_post_contactlist_contacts_bulk`	Get contacts from a contact list.
`genesys-outbound_post_contactlist_contacts_bulk_remove`	Start an async job to delete contacts using a filter.
`genesys-outbound_post_contactlist_contacts_bulk_update`	Start an async job to bulk edit contacts.
`genesys-outbound_post_contactlist_contacts_search`	Query contacts from a contact list.
`genesys-outbound_post_contactlist_export`	Initiate the export of a contact list.
`genesys-outbound_post_contactlistfilters`	Create Contact List Filter
`genesys-outbound_post_contactlistfilters_bulk_retrieve`	Retrieve multiple contact list filters
`genesys-outbound_post_contactlistfilters_preview`	Get a preview of the output of a contact list filter
`genesys-outbound_post_contactlists`	Create a contact List.
`genesys-outbound_post_contactlists_uploads`	Generate presigned upload URL for contact list.
`genesys-outbound_post_contactlisttemplates`	Create Contact List Template
`genesys-outbound_post_contactlisttemplates_bulk_add`	Add multiple contact list templates
`genesys-outbound_post_contactlisttemplates_bulk_retrieve`	Get multiple contact list templates
`genesys-outbound_post_conversation_dnc`	Add phone numbers to a Dialer DNC list.
`genesys-outbound_post_digitalrulesets`	Create an Outbound Digital Rule Set
`genesys-outbound_post_dnclist_emailaddresses`	Add email addresses to a DNC list.
`genesys-outbound_post_dnclist_export`	Initiate the export of a dnc list.
`genesys-outbound_post_dnclist_phonenumbers`	Add phone numbers to a DNC list.
`genesys-outbound_post_dnclists`	Create dialer DNC list
`genesys-outbound_post_dnclists_uploads`	Generate presigned upload URL for dnc list.
`genesys-outbound_post_filespecificationtemplates`	Create File Specification Template
`genesys-outbound_post_importtemplates`	Create Import Template
`genesys-outbound_post_importtemplates_bulk_add`	Add multiple import templates
`genesys-outbound_post_messagingcampaign_start`	Start the campaign
`genesys-outbound_post_messagingcampaign_stop`	Stop the campaign
`genesys-outbound_post_messagingcampaigns`	Create a Messaging Campaign
`genesys-outbound_post_messagingcampaigns_progress`	Get progress for a list of messaging campaigns
`genesys-outbound_post_rulesets`	Create a Rule Set.
`genesys-outbound_post_sequences`	Create a new campaign sequence.
`genesys-outbound_put_attemptlimit`	Update attempt limits
`genesys-outbound_put_callabletimeset`	Update callable time set
`genesys-outbound_put_callanalysisresponseset`	Update a dialer call analysis response set.
`genesys-outbound_put_campaign`	Update a campaign.
`genesys-outbound_put_campaign_agent`	Send notification that an agent’s state changed
`genesys-outbound_put_campaignrule`	Update Campaign Rule
`genesys-outbound_put_contactlist`	Update a contact list.
`genesys-outbound_put_contactlist_contact`	Update a contact.
`genesys-outbound_put_contactlistfilter`	Update Contact List Filter
`genesys-outbound_put_contactlisttemplate`	Update a contact list template.
`genesys-outbound_put_digitalruleset`	Update an Outbound Digital Rule Set
`genesys-outbound_put_dnclist`	Update dialer DNC list
`genesys-outbound_put_filespecificationtemplate`	Update File Specification Template
`genesys-outbound_put_importtemplate`	Update Import Template
`genesys-outbound_put_messagingcampaign`	Update an Outbound Messaging Campaign
`genesys-outbound_put_ruleset`	Update a Rule Set.
`genesys-outbound_put_schedules_campaign`	Update a new campaign schedule.
`genesys-outbound_put_schedules_emailcampaign`	Update an email campaign schedule.
`genesys-outbound_put_schedules_messagingcampaign`	Update a new messaging campaign schedule.
`genesys-outbound_put_schedules_sequence`	Update a new sequence schedule.
`genesys-outbound_put_schedules_whatsappcampaign`	Update a WhatsApp campaign schedule.
`genesys-outbound_put_sequence`	Update a new campaign sequence.
`genesys-outbound_put_wrapupcodemappings`	Update the Dialer wrap up code mapping.

genesys-outbound_delete_attemptlimit

Delete attempt limits Parameters:

Parameter	Type	Required	Default	Description
`attemptLimitsId`	string	Yes	—	Attempt limits ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "attemptLimitsId": {
      "type": "string",
      "description": "Attempt limits ID"
    }
  },
  "required": [
    "PCID",
    "attemptLimitsId"
  ]
}

genesys-outbound_delete_callabletimeset

Delete callable time set Parameters:

Parameter	Type	Required	Default	Description
`callableTimeSetId`	string	Yes	—	Callable Time Set ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "callableTimeSetId": {
      "type": "string",
      "description": "Callable Time Set ID"
    }
  },
  "required": [
    "PCID",
    "callableTimeSetId"
  ]
}

genesys-outbound_delete_callanalysisresponseset

Delete a dialer call analysis response set. Parameters:

Parameter	Type	Required	Default	Description
`callAnalysisSetId`	string	Yes	—	Call Analysis Response Set ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "callAnalysisSetId": {
      "type": "string",
      "description": "Call Analysis Response Set ID"
    }
  },
  "required": [
    "PCID",
    "callAnalysisSetId"
  ]
}

genesys-outbound_delete_campaign

Delete a campaign. Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	string	Yes	—	Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "string",
      "description": "Campaign ID"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

genesys-outbound_delete_campaign_progress

Reset campaign progress and recycle the campaign Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	string	Yes	—	Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "string",
      "description": "Campaign ID"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

genesys-outbound_delete_campaignrule

Delete Campaign Rule Parameters:

Parameter	Type	Required	Default	Description
`campaignRuleId`	string	Yes	—	Campaign Rule ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignRuleId": {
      "type": "string",
      "description": "Campaign Rule ID"
    }
  },
  "required": [
    "PCID",
    "campaignRuleId"
  ]
}

genesys-outbound_delete_contactlist

Delete a contact list. Parameters:

Parameter	Type	Required	Default	Description
`contactListId`	string	Yes	—	ContactList ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListId": {
      "type": "string",
      "description": "ContactList ID"
    }
  },
  "required": [
    "PCID",
    "contactListId"
  ]
}

genesys-outbound_delete_contactlist_contact

Delete a contact. Parameters:

Parameter	Type	Required	Default	Description
`contactListId`	string	Yes	—	Contact List ID
`contactId`	string	Yes	—	Contact ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListId": {
      "type": "string",
      "description": "Contact List ID"
    },
    "contactId": {
      "type": "string",
      "description": "Contact ID"
    }
  },
  "required": [
    "PCID",
    "contactListId",
    "contactId"
  ]
}

genesys-outbound_delete_contactlist_contacts

Delete contacts from a contact list. Only contacts that are not in use by any campaign will be deleted Parameters:

Parameter	Type	Required	Default	Description
`contactListId`	string	Yes	—	Contact List ID
`contactIds`	string[]	Yes	—	ContactIds to delete.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListId": {
      "type": "string",
      "description": "Contact List ID"
    },
    "contactIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "ContactIds to delete."
    }
  },
  "required": [
    "PCID",
    "contactListId",
    "contactIds"
  ]
}

genesys-outbound_delete_contactlistfilter

Delete Contact List Filter Parameters:

Parameter	Type	Required	Default	Description
`contactListFilterId`	string	Yes	—	Contact List Filter ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListFilterId": {
      "type": "string",
      "description": "Contact List Filter ID"
    }
  },
  "required": [
    "PCID",
    "contactListFilterId"
  ]
}

genesys-outbound_delete_contactlists

Delete multiple contact lists. Parameters:

Parameter	Type	Required	Default	Description
`id`	string[]	Yes	—	contact list id(s) to delete

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "contact list id(s) to delete"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

genesys-outbound_delete_contactlisttemplate

Delete Contact List Template Parameters:

Parameter	Type	Required	Default	Description
`contactListTemplateId`	string	Yes	—	ContactListTemplate ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListTemplateId": {
      "type": "string",
      "description": "ContactListTemplate ID"
    }
  },
  "required": [
    "PCID",
    "contactListTemplateId"
  ]
}

genesys-outbound_delete_contactlisttemplates

Delete multiple contact list templates. Parameters:

Parameter	Type	Required	Default	Description
`id`	string[]	Yes	—	contact list template id(s) to delete

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "contact list template id(s) to delete"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

genesys-outbound_delete_digitalruleset

Delete an Outbound Digital Rule Set Parameters:

Parameter	Type	Required	Default	Description
`digitalRuleSetId`	string	Yes	—	The Digital Rule Set ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "digitalRuleSetId": {
      "type": "string",
      "description": "The Digital Rule Set ID"
    }
  },
  "required": [
    "PCID",
    "digitalRuleSetId"
  ]
}

genesys-outbound_delete_dnclist

Delete dialer DNC list Parameters:

Parameter	Type	Required	Default	Description
`dncListId`	string	Yes	—	DncList ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dncListId": {
      "type": "string",
      "description": "DncList ID"
    }
  },
  "required": [
    "PCID",
    "dncListId"
  ]
}

genesys-outbound_delete_dnclist_customexclusioncolumns

Deletes all or expired custom exclusion column entries from a DNC list. Parameters:

Parameter	Type	Required	Default	Description
`dncListId`	string	Yes	—	DncList ID
`expiredOnly`	boolean	No	—	Set to true to only remove DNC entries that are expired

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dncListId": {
      "type": "string",
      "description": "DncList ID"
    },
    "expiredOnly": {
      "type": "boolean",
      "description": "Set to true to only remove DNC entries that are expired"
    }
  },
  "required": [
    "PCID",
    "dncListId"
  ]
}

genesys-outbound_delete_dnclist_emailaddresses

Deletes all or expired email addresses from a DNC list. Parameters:

Parameter	Type	Required	Default	Description
`dncListId`	string	Yes	—	DncList ID
`expiredOnly`	boolean	No	—	Set to true to only remove DNC entries that are expired

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dncListId": {
      "type": "string",
      "description": "DncList ID"
    },
    "expiredOnly": {
      "type": "boolean",
      "description": "Set to true to only remove DNC entries that are expired"
    }
  },
  "required": [
    "PCID",
    "dncListId"
  ]
}

genesys-outbound_delete_dnclist_phonenumbers

Deletes all or expired phone numbers from a DNC list. Parameters:

Parameter	Type	Required	Default	Description
`dncListId`	string	Yes	—	DncList ID
`expiredOnly`	boolean	No	—	Set to true to only remove DNC entries that are expired

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dncListId": {
      "type": "string",
      "description": "DncList ID"
    },
    "expiredOnly": {
      "type": "boolean",
      "description": "Set to true to only remove DNC entries that are expired"
    }
  },
  "required": [
    "PCID",
    "dncListId"
  ]
}

genesys-outbound_delete_dnclist_whatsappnumbers

Deletes all or expired whatsApp numbers from a DNC list. Parameters:

Parameter	Type	Required	Default	Description
`dncListId`	string	Yes	—	DncList ID
`expiredOnly`	boolean	No	—	Set to true to only remove DNC whatsApp numbers that are expired

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dncListId": {
      "type": "string",
      "description": "DncList ID"
    },
    "expiredOnly": {
      "type": "boolean",
      "description": "Set to true to only remove DNC whatsApp numbers that are expired"
    }
  },
  "required": [
    "PCID",
    "dncListId"
  ]
}

genesys-outbound_delete_filespecificationtemplate

Delete File Specification Template Parameters:

Parameter	Type	Required	Default	Description
`fileSpecificationTemplateId`	string	Yes	—	File Specification Template ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fileSpecificationTemplateId": {
      "type": "string",
      "description": "File Specification Template ID"
    }
  },
  "required": [
    "PCID",
    "fileSpecificationTemplateId"
  ]
}

genesys-outbound_delete_filespecificationtemplates_bulk

Delete multiple file specification templates. Parameters:

Parameter	Type	Required	Default	Description
`id`	string[]	Yes	—	File Specification template id(s) to delete

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "File Specification template id(s) to delete"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

genesys-outbound_delete_importtemplate

Delete Import Template Parameters:

Parameter	Type	Required	Default	Description
`importTemplateId`	string	Yes	—	Import Template ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "importTemplateId": {
      "type": "string",
      "description": "Import Template ID"
    }
  },
  "required": [
    "PCID",
    "importTemplateId"
  ]
}

genesys-outbound_delete_importtemplates

Delete multiple import templates. Parameters:

Parameter	Type	Required	Default	Description
`id`	string[]	Yes	—	import template id(s) to delete

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "import template id(s) to delete"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

genesys-outbound_delete_messagingcampaign

Delete an Outbound Messaging Campaign Parameters:

Parameter	Type	Required	Default	Description
`messagingCampaignId`	string	Yes	—	The Messaging Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "messagingCampaignId": {
      "type": "string",
      "description": "The Messaging Campaign ID"
    }
  },
  "required": [
    "PCID",
    "messagingCampaignId"
  ]
}

genesys-outbound_delete_messagingcampaign_progress

Reset messaging campaign progress and recycle the messaging campaign Parameters:

Parameter	Type	Required	Default	Description
`messagingCampaignId`	string	Yes	—	The Messaging Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "messagingCampaignId": {
      "type": "string",
      "description": "The Messaging Campaign ID"
    }
  },
  "required": [
    "PCID",
    "messagingCampaignId"
  ]
}

genesys-outbound_delete_ruleset

Delete a Rule Set. Parameters:

Parameter	Type	Required	Default	Description
`ruleSetId`	string	Yes	—	Rule Set ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ruleSetId": {
      "type": "string",
      "description": "Rule Set ID"
    }
  },
  "required": [
    "PCID",
    "ruleSetId"
  ]
}

genesys-outbound_delete_schedules_campaign

Delete a dialer campaign schedule. Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	string	Yes	—	Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "string",
      "description": "Campaign ID"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

genesys-outbound_delete_schedules_emailcampaign

Delete an email campaign schedule. Parameters:

Parameter	Type	Required	Default	Description
`emailCampaignId`	string	Yes	—	Email Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "emailCampaignId": {
      "type": "string",
      "description": "Email Campaign ID"
    }
  },
  "required": [
    "PCID",
    "emailCampaignId"
  ]
}

genesys-outbound_delete_schedules_messagingcampaign

Delete a messaging campaign schedule. Parameters:

Parameter	Type	Required	Default	Description
`messagingCampaignId`	string	Yes	—	Messaging Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "messagingCampaignId": {
      "type": "string",
      "description": "Messaging Campaign ID"
    }
  },
  "required": [
    "PCID",
    "messagingCampaignId"
  ]
}

genesys-outbound_delete_schedules_sequence

Delete a dialer sequence schedule. Parameters:

Parameter	Type	Required	Default	Description
`sequenceId`	string	Yes	—	Sequence ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sequenceId": {
      "type": "string",
      "description": "Sequence ID"
    }
  },
  "required": [
    "PCID",
    "sequenceId"
  ]
}

genesys-outbound_delete_schedules_whatsappcampaign

Delete a WhatsApp campaign schedule. Parameters:

Parameter	Type	Required	Default	Description
`whatsAppCampaignId`	string	Yes	—	WhatsApp Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "whatsAppCampaignId": {
      "type": "string",
      "description": "WhatsApp Campaign ID"
    }
  },
  "required": [
    "PCID",
    "whatsAppCampaignId"
  ]
}

genesys-outbound_delete_sequence

Delete a dialer campaign sequence. Parameters:

Parameter	Type	Required	Default	Description
`sequenceId`	string	Yes	—	Campaign Sequence ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sequenceId": {
      "type": "string",
      "description": "Campaign Sequence ID"
    }
  },
  "required": [
    "PCID",
    "sequenceId"
  ]
}

genesys-outbound_get_attemptlimit

Get attempt limits Parameters:

Parameter	Type	Required	Default	Description
`attemptLimitsId`	string	Yes	—	Attempt limits ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "attemptLimitsId": {
      "type": "string",
      "description": "Attempt limits ID"
    }
  },
  "required": [
    "PCID",
    "attemptLimitsId"
  ]
}

genesys-outbound_get_attemptlimits

Query attempt limits list Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	Page size. The max that will be returned is 100.
`pageNumber`	integer	No	—	Page number
`allowEmptyResult`	boolean	No	—	Whether to return an empty page when there are no results for that page
`filterType`	string	No	—	Filter type
`name`	string	No	—	The name value
`sortBy`	string	No	—	Sort by
`sortOrder`	string	No	—	Sort order

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size. The max that will be returned is 100."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "allowEmptyResult": {
      "type": "boolean",
      "description": "Whether to return an empty page when there are no results for that page"
    },
    "filterType": {
      "type": "string",
      "description": "Filter type",
      "enum": [
        "Equals",
        "RegEx",
        "Contains",
        "Prefix",
        "LessThan",
        "LessThanEqualTo",
        "GreaterThan",
        "GreaterThanEqualTo",
        "BeginsWith",
        "EndsWith"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "sortBy": {
      "type": "string",
      "description": "Sort by"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sort order",
      "enum": [
        "ascending",
        "descending"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_callabletimeset

Get callable time set Parameters:

Parameter	Type	Required	Default	Description
`callableTimeSetId`	string	Yes	—	Callable Time Set ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "callableTimeSetId": {
      "type": "string",
      "description": "Callable Time Set ID"
    }
  },
  "required": [
    "PCID",
    "callableTimeSetId"
  ]
}

genesys-outbound_get_callabletimesets

Query callable time set list Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	Page size. The max that will be returned is 100.
`pageNumber`	integer	No	—	Page number
`allowEmptyResult`	boolean	No	—	Whether to return an empty page when there are no results for that page
`filterType`	string	No	—	Filter type
`name`	string	No	—	The name value
`sortBy`	string	No	—	Sort by
`sortOrder`	string	No	—	Sort order

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size. The max that will be returned is 100."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "allowEmptyResult": {
      "type": "boolean",
      "description": "Whether to return an empty page when there are no results for that page"
    },
    "filterType": {
      "type": "string",
      "description": "Filter type",
      "enum": [
        "Equals",
        "RegEx",
        "Contains",
        "Prefix",
        "LessThan",
        "LessThanEqualTo",
        "GreaterThan",
        "GreaterThanEqualTo",
        "BeginsWith",
        "EndsWith"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "sortBy": {
      "type": "string",
      "description": "Sort by"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sort order",
      "enum": [
        "ascending",
        "descending"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_callanalysisresponseset

Get a dialer call analysis response set. Parameters:

Parameter	Type	Required	Default	Description
`callAnalysisSetId`	string	Yes	—	Call Analysis Response Set ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "callAnalysisSetId": {
      "type": "string",
      "description": "Call Analysis Response Set ID"
    }
  },
  "required": [
    "PCID",
    "callAnalysisSetId"
  ]
}

genesys-outbound_get_callanalysisresponsesets

Query a list of dialer call analysis response sets. Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	Page size. The max that will be returned is 100.
`pageNumber`	integer	No	—	Page number
`allowEmptyResult`	boolean	No	—	Whether to return an empty page when there are no results for that page
`filterType`	string	No	—	Filter type
`name`	string	No	—	The name value
`sortBy`	string	No	—	Sort by
`sortOrder`	string	No	—	Sort order

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size. The max that will be returned is 100."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "allowEmptyResult": {
      "type": "boolean",
      "description": "Whether to return an empty page when there are no results for that page"
    },
    "filterType": {
      "type": "string",
      "description": "Filter type",
      "enum": [
        "Equals",
        "RegEx",
        "Contains",
        "Prefix",
        "LessThan",
        "LessThanEqualTo",
        "GreaterThan",
        "GreaterThanEqualTo",
        "BeginsWith",
        "EndsWith"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "sortBy": {
      "type": "string",
      "description": "Sort by"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sort order",
      "enum": [
        "ascending",
        "descending"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_campaign

Get dialer campaign. Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	string	Yes	—	Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "string",
      "description": "Campaign ID"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

genesys-outbound_get_campaign_agentownedmappingpreview_results

Get a preview of how agents will be mapped to this campaign’s contact list. Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	string	Yes	—	Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "string",
      "description": "Campaign ID"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

genesys-outbound_get_campaign_diagnostics

Get campaign diagnostics Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	string	Yes	—	Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "string",
      "description": "Campaign ID"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

genesys-outbound_get_campaign_interactions

Get dialer campaign interactions. Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	string	Yes	—	Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "string",
      "description": "Campaign ID"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

genesys-outbound_get_campaign_linedistribution

Get line distribution information for campaigns using same Edge Group or Site as given campaign Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	string	Yes	—	Campaign ID
`includeOnlyActiveCampaigns`	boolean	No	—	If true will return only active Campaigns
`edgeGroupId`	string	No	—	Edge group to be used in line distribution calculations instead of current Campaign’s Edge Group. Campaign’s Site and Edge Group are mutually exclusive.
`siteId`	string	No	—	Site to be used in line distribution calculations instead of current Campaign’s Site. Campaign’s Site and Edge Group are mutually exclusive.
`useWeight`	boolean	No	—	Enable usage of weight, this value overrides current Campaign’s setting in line distribution calculations
`relativeWeight`	integer	No	—	Relative weight to be used in line distribution calculations instead of current Campaign’s relative weight
`outboundLineCount`	integer	No	—	The number of outbound lines to be used in line distribution calculations, instead of current Campaign’s Outbound Lines Count

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "string",
      "description": "Campaign ID"
    },
    "includeOnlyActiveCampaigns": {
      "type": "boolean",
      "description": "If true will return only active Campaigns"
    },
    "edgeGroupId": {
      "type": "string",
      "description": "Edge group to be used in line distribution calculations instead of current Campaign's Edge Group. Campaign's Site and Edge Group are mutually exclusive."
    },
    "siteId": {
      "type": "string",
      "description": "Site to be used in line distribution calculations instead of current Campaign's Site.  Campaign's Site and Edge Group are mutually exclusive."
    },
    "useWeight": {
      "type": "boolean",
      "description": "Enable usage of weight, this value overrides current Campaign's setting in line distribution calculations"
    },
    "relativeWeight": {
      "type": "integer",
      "description": "Relative weight to be used in line distribution calculations instead of current Campaign's relative weight"
    },
    "outboundLineCount": {
      "type": "integer",
      "description": "The number of outbound lines to be used in line distribution calculations, instead of current Campaign's Outbound Lines Count"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

genesys-outbound_get_campaign_progress

Get campaign progress Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	string	Yes	—	Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "string",
      "description": "Campaign ID"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

genesys-outbound_get_campaign_skillcombinations

Get the remaining and total contact count for each skill combination in a skills campaign Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	string	Yes	—	Campaign ID
`pageNumber`	integer	No	—	Page number
`pageSize`	integer	No	—	Page size

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "string",
      "description": "Campaign ID"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

genesys-outbound_get_campaign_stats

Get statistics about a Dialer Campaign Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	string	Yes	—	Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "string",
      "description": "Campaign ID"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

genesys-outbound_get_campaignrule

Get Campaign Rule Parameters:

Parameter	Type	Required	Default	Description
`campaignRuleId`	string	Yes	—	Campaign Rule ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignRuleId": {
      "type": "string",
      "description": "Campaign Rule ID"
    }
  },
  "required": [
    "PCID",
    "campaignRuleId"
  ]
}

genesys-outbound_get_campaignrules

Query Campaign Rule list Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	Page size. The max that will be returned is 100.
`pageNumber`	integer	No	—	Page number
`allowEmptyResult`	boolean	No	—	Whether to return an empty page when there are no results for that page
`filterType`	string	No	—	Filter type
`name`	string	No	—	The name value
`sortBy`	string	No	—	Sort by
`sortOrder`	string	No	—	Sort order

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size. The max that will be returned is 100."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "allowEmptyResult": {
      "type": "boolean",
      "description": "Whether to return an empty page when there are no results for that page"
    },
    "filterType": {
      "type": "string",
      "description": "Filter type",
      "enum": [
        "Equals",
        "RegEx",
        "Contains",
        "Prefix",
        "LessThan",
        "LessThanEqualTo",
        "GreaterThan",
        "GreaterThanEqualTo",
        "BeginsWith",
        "EndsWith"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "sortBy": {
      "type": "string",
      "description": "Sort by"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sort order",
      "enum": [
        "ascending",
        "descending"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_campaigns

Query a list of dialer campaigns. Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	Page size. The max that will be returned is 100.
`pageNumber`	integer	No	—	Page number
`filterType`	string	No	—	Filter type
`name`	string	No	—	The name value
`id`	string[]	No	—	The id value
`contactListId`	string	No	—	Contact List ID
`dncListIds`	string	No	—	DNC list ID
`distributionQueueId`	string	No	—	Distribution queue ID
`edgeGroupId`	string	No	—	Edge group ID
`callAnalysisResponseSetId`	string	No	—	Call analysis response set ID
`divisionId`	string[]	No	—	Division ID(s)
`sortBy`	string	No	—	Sort by
`sortOrder`	string	No	—	Sort order

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size. The max that will be returned is 100."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "filterType": {
      "type": "string",
      "description": "Filter type",
      "enum": [
        "Equals",
        "RegEx",
        "Contains",
        "Prefix",
        "LessThan",
        "LessThanEqualTo",
        "GreaterThan",
        "GreaterThanEqualTo",
        "BeginsWith",
        "EndsWith"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "id": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The id value"
    },
    "contactListId": {
      "type": "string",
      "description": "Contact List ID"
    },
    "dncListIds": {
      "type": "string",
      "description": "DNC list ID"
    },
    "distributionQueueId": {
      "type": "string",
      "description": "Distribution queue ID"
    },
    "edgeGroupId": {
      "type": "string",
      "description": "Edge group ID"
    },
    "callAnalysisResponseSetId": {
      "type": "string",
      "description": "Call analysis response set ID"
    },
    "divisionId": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Division ID(s)"
    },
    "sortBy": {
      "type": "string",
      "description": "Sort by"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sort order",
      "enum": [
        "ascending",
        "descending"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_campaigns_all

Query across all types of campaigns by division Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	Page size
`pageNumber`	integer	No	—	Page number
`id`	string[]	No	—	Campaign ID(s)
`name`	string	No	—	Campaign name(s)
`divisionId`	string[]	No	—	Division ID(s)
`mediaType`	string[]	No	—	Media type(s)
`sortOrder`	string	No	—	Sort order

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "id": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Campaign ID(s)"
    },
    "name": {
      "type": "string",
      "description": "Campaign name(s)"
    },
    "divisionId": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Division ID(s)"
    },
    "mediaType": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "email",
          "sms",
          "voice",
          "whatsapp"
        ]
      },
      "description": "Media type(s)"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sort order",
      "enum": [
        "ascending",
        "descending"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_campaigns_all_divisionviews

Query across all types of campaigns Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	Page size
`pageNumber`	integer	No	—	Page number
`id`	string[]	No	—	Campaign ID(s)
`name`	string	No	—	Campaign name(s)
`divisionId`	string[]	No	—	Division ID(s)
`mediaType`	string[]	No	—	Media type(s)
`sortOrder`	string	No	—	Sort order

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "id": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Campaign ID(s)"
    },
    "name": {
      "type": "string",
      "description": "Campaign name(s)"
    },
    "divisionId": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Division ID(s)"
    },
    "mediaType": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "email",
          "sms",
          "voice",
          "whatsapp"
        ]
      },
      "description": "Media type(s)"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sort order",
      "enum": [
        "ascending",
        "descending"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_campaigns_divisionview

Get a basic Campaign information object Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	string	Yes	—	Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "string",
      "description": "Campaign ID"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

genesys-outbound_get_campaigns_divisionviews

Query a list of basic Campaign information objects Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	Page size. The max that will be returned is 100.
`pageNumber`	integer	No	—	Page number
`filterType`	string	No	—	Filter type
`name`	string	No	—	The name value
`id`	string[]	No	—	The id value
`sortBy`	string	No	—	Sort by
`sortOrder`	string	No	—	Sort order

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size. The max that will be returned is 100."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "filterType": {
      "type": "string",
      "description": "Filter type",
      "enum": [
        "Equals",
        "RegEx",
        "Contains",
        "Prefix",
        "LessThan",
        "LessThanEqualTo",
        "GreaterThan",
        "GreaterThanEqualTo",
        "BeginsWith",
        "EndsWith"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "id": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The id value"
    },
    "sortBy": {
      "type": "string",
      "description": "Sort by"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sort order",
      "enum": [
        "ascending",
        "descending"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_contactlist

Get a dialer contact list. Parameters:

Parameter	Type	Required	Default	Description
`contactListId`	string	Yes	—	ContactList ID
`includeImportStatus`	boolean	No	—	Import status
`includeSize`	boolean	No	—	Include size

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListId": {
      "type": "string",
      "description": "ContactList ID"
    },
    "includeImportStatus": {
      "type": "boolean",
      "description": "Import status"
    },
    "includeSize": {
      "type": "boolean",
      "description": "Include size"
    }
  },
  "required": [
    "PCID",
    "contactListId"
  ]
}

genesys-outbound_get_contactlist_contact

Get a contact. Parameters:

Parameter	Type	Required	Default	Description
`contactListId`	string	Yes	—	Contact List ID
`contactId`	string	Yes	—	Contact ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListId": {
      "type": "string",
      "description": "Contact List ID"
    },
    "contactId": {
      "type": "string",
      "description": "Contact ID"
    }
  },
  "required": [
    "PCID",
    "contactListId",
    "contactId"
  ]
}

genesys-outbound_get_contactlist_contacts_bulk_job

Get bulk operation job. Parameters:

Parameter	Type	Required	Default	Description
`contactListId`	string	Yes	—	Contact List ID
`jobId`	string	Yes	—	Job ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListId": {
      "type": "string",
      "description": "Contact List ID"
    },
    "jobId": {
      "type": "string",
      "description": "Job ID"
    }
  },
  "required": [
    "PCID",
    "contactListId",
    "jobId"
  ]
}

genesys-outbound_get_contactlist_contacts_bulk_jobs

Get 10 most recent bulk operation jobs associated with contact list. Parameters:

Parameter	Type	Required	Default	Description
`contactListId`	string	Yes	—	Contact List ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListId": {
      "type": "string",
      "description": "Contact List ID"
    }
  },
  "required": [
    "PCID",
    "contactListId"
  ]
}

genesys-outbound_get_contactlist_export

Get the URI of a contact list export. Parameters:

Parameter	Type	Required	Default	Description
`contactListId`	string	Yes	—	ContactList ID
`download`	string	No	—	Redirect to download uri

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListId": {
      "type": "string",
      "description": "ContactList ID"
    },
    "download": {
      "type": "string",
      "description": "Redirect to download uri"
    }
  },
  "required": [
    "PCID",
    "contactListId"
  ]
}

genesys-outbound_get_contactlist_importstatus

Get dialer contactList import status. Parameters:

Parameter	Type	Required	Default	Description
`contactListId`	string	Yes	—	ContactList ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListId": {
      "type": "string",
      "description": "ContactList ID"
    }
  },
  "required": [
    "PCID",
    "contactListId"
  ]
}

genesys-outbound_get_contactlist_timezonemappingpreview

Preview the result of applying Automatic Time Zone Mapping to a contact list Parameters:

Parameter	Type	Required	Default	Description
`contactListId`	string	Yes	—	ContactList ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListId": {
      "type": "string",
      "description": "ContactList ID"
    }
  },
  "required": [
    "PCID",
    "contactListId"
  ]
}

genesys-outbound_get_contactlistfilter

Get Contact list filter Parameters:

Parameter	Type	Required	Default	Description
`contactListFilterId`	string	Yes	—	Contact List Filter ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListFilterId": {
      "type": "string",
      "description": "Contact List Filter ID"
    }
  },
  "required": [
    "PCID",
    "contactListFilterId"
  ]
}

genesys-outbound_get_contactlistfilters

Query Contact list filters Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	Page size. The max that will be returned is 100.
`pageNumber`	integer	No	—	Page number
`allowEmptyResult`	boolean	No	—	Whether to return an empty page when there are no results for that page
`filterType`	string	No	—	Filter type
`name`	string	No	—	The name value
`sortBy`	string	No	—	Sort by
`sortOrder`	string	No	—	Sort order
`contactListId`	string	No	—	Contact List ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size. The max that will be returned is 100."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "allowEmptyResult": {
      "type": "boolean",
      "description": "Whether to return an empty page when there are no results for that page"
    },
    "filterType": {
      "type": "string",
      "description": "Filter type",
      "enum": [
        "Equals",
        "RegEx",
        "Contains",
        "Prefix",
        "LessThan",
        "LessThanEqualTo",
        "GreaterThan",
        "GreaterThanEqualTo",
        "BeginsWith",
        "EndsWith"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "sortBy": {
      "type": "string",
      "description": "Sort by"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sort order",
      "enum": [
        "ascending",
        "descending"
      ]
    },
    "contactListId": {
      "type": "string",
      "description": "Contact List ID"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_contactlists

Query a list of contact lists. Parameters:

Parameter	Type	Required	Default	Description
`includeImportStatus`	boolean	No	—	Include import status
`includeSize`	boolean	No	—	Include size
`pageSize`	integer	No	—	Page size. The max that will be returned is 100.
`pageNumber`	integer	No	—	Page number
`allowEmptyResult`	boolean	No	—	Whether to return an empty page when there are no results for that page
`filterType`	string	No	—	Filter type
`name`	string	No	—	The name value
`id`	string[]	No	—	The id value
`divisionId`	string[]	No	—	Division ID(s)
`sortBy`	string	No	—	Sort by
`sortOrder`	string	No	—	Sort order

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "includeImportStatus": {
      "type": "boolean",
      "description": "Include import status"
    },
    "includeSize": {
      "type": "boolean",
      "description": "Include size"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size. The max that will be returned is 100."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "allowEmptyResult": {
      "type": "boolean",
      "description": "Whether to return an empty page when there are no results for that page"
    },
    "filterType": {
      "type": "string",
      "description": "Filter type",
      "enum": [
        "Equals",
        "RegEx",
        "Contains",
        "Prefix",
        "LessThan",
        "LessThanEqualTo",
        "GreaterThan",
        "GreaterThanEqualTo",
        "BeginsWith",
        "EndsWith"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "id": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The id value"
    },
    "divisionId": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Division ID(s)"
    },
    "sortBy": {
      "type": "string",
      "description": "Sort by"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sort order",
      "enum": [
        "ascending",
        "descending"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_contactlists_divisionview

Get a basic ContactList information object Parameters:

Parameter	Type	Required	Default	Description
`contactListId`	string	Yes	—	Contactlist ID
`includeImportStatus`	boolean	No	—	Include import status
`includeSize`	boolean	No	—	Include size

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListId": {
      "type": "string",
      "description": "Contactlist ID"
    },
    "includeImportStatus": {
      "type": "boolean",
      "description": "Include import status"
    },
    "includeSize": {
      "type": "boolean",
      "description": "Include size"
    }
  },
  "required": [
    "PCID",
    "contactListId"
  ]
}

genesys-outbound_get_contactlists_divisionviews

Query a list of simplified contact list objects. Parameters:

Parameter	Type	Required	Default	Description
`includeImportStatus`	boolean	No	—	Include import status
`includeSize`	boolean	No	—	Include size
`pageSize`	integer	No	—	Page size. The max that will be returned is 100.
`pageNumber`	integer	No	—	Page number
`filterType`	string	No	—	Filter type
`name`	string	No	—	The name value
`id`	string[]	No	—	The id value
`sortBy`	string	No	—	Sort by
`sortOrder`	string	No	—	Sort order

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "includeImportStatus": {
      "type": "boolean",
      "description": "Include import status"
    },
    "includeSize": {
      "type": "boolean",
      "description": "Include size"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size. The max that will be returned is 100."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "filterType": {
      "type": "string",
      "description": "Filter type",
      "enum": [
        "Equals",
        "RegEx",
        "Contains",
        "Prefix",
        "LessThan",
        "LessThanEqualTo",
        "GreaterThan",
        "GreaterThanEqualTo",
        "BeginsWith",
        "EndsWith"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "id": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The id value"
    },
    "sortBy": {
      "type": "string",
      "description": "Sort by"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sort order",
      "enum": [
        "ascending",
        "descending"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_contactlisttemplate

Get Contact List Template Parameters:

Parameter	Type	Required	Default	Description
`contactListTemplateId`	string	Yes	—	ContactListTemplate ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListTemplateId": {
      "type": "string",
      "description": "ContactListTemplate ID"
    }
  },
  "required": [
    "PCID",
    "contactListTemplateId"
  ]
}

genesys-outbound_get_contactlisttemplates

Query a list of contact list templates Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	Page size. The max that will be returned is 100.
`pageNumber`	integer	No	—	Page number
`allowEmptyResult`	boolean	No	—	Whether to return an empty page when there are no results for that page
`filterType`	string	No	—	Filter type
`name`	string	No	—	The name value
`sortBy`	string	No	—	Sort by
`sortOrder`	string	No	—	Sort order

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size. The max that will be returned is 100."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "allowEmptyResult": {
      "type": "boolean",
      "description": "Whether to return an empty page when there are no results for that page"
    },
    "filterType": {
      "type": "string",
      "description": "Filter type",
      "enum": [
        "Equals",
        "RegEx",
        "Contains",
        "Prefix",
        "LessThan",
        "LessThanEqualTo",
        "GreaterThan",
        "GreaterThanEqualTo",
        "BeginsWith",
        "EndsWith"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "sortBy": {
      "type": "string",
      "description": "Sort by"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sort order",
      "enum": [
        "ascending",
        "descending"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_diagnostics_campaign_summary

Get diagnostic summary for a single campaign Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	string	Yes	—	Campaign ID
`start`	string	Yes	—	Start datetime (ISO 8601 or Unix epoch)
`end`	string	Yes	—	End datetime (ISO 8601 or Unix epoch)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "string",
      "description": "Campaign ID"
    },
    "start": {
      "type": "string",
      "description": "Start datetime (ISO 8601 or Unix epoch)"
    },
    "end": {
      "type": "string",
      "description": "End datetime (ISO 8601 or Unix epoch)"
    }
  },
  "required": [
    "PCID",
    "campaignId",
    "start",
    "end"
  ]
}

genesys-outbound_get_digitalruleset

Get an Outbound Digital Rule Set Parameters:

Parameter	Type	Required	Default	Description
`digitalRuleSetId`	string	Yes	—	The Digital Rule Set ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "digitalRuleSetId": {
      "type": "string",
      "description": "The Digital Rule Set ID"
    }
  },
  "required": [
    "PCID",
    "digitalRuleSetId"
  ]
}

genesys-outbound_get_digitalrulesets

Query a list of Outbound Digital Rule Sets Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	Page size. The max that will be returned is 100.
`pageNumber`	integer	No	—	Page number
`sortBy`	string	No	—	The field to sort by
`sortOrder`	string	No	—	The direction to sort
`name`	string	No	—	The name value
`id`	string[]	No	—	A list of digital rule set ids to bulk fetch

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size. The max that will be returned is 100."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "sortBy": {
      "type": "string",
      "description": "The field to sort by",
      "enum": [
        "name"
      ]
    },
    "sortOrder": {
      "type": "string",
      "description": "The direction to sort",
      "enum": [
        "ascending",
        "descending"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "id": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of digital rule set ids to bulk fetch"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_dnclist

Get dialer DNC list Parameters:

Parameter	Type	Required	Default	Description
`dncListId`	string	Yes	—	DncList ID
`includeImportStatus`	boolean	No	—	Import status
`includeSize`	boolean	No	—	Include size

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dncListId": {
      "type": "string",
      "description": "DncList ID"
    },
    "includeImportStatus": {
      "type": "boolean",
      "description": "Import status"
    },
    "includeSize": {
      "type": "boolean",
      "description": "Include size"
    }
  },
  "required": [
    "PCID",
    "dncListId"
  ]
}

genesys-outbound_get_dnclist_export

Get the URI of a DNC list export. Parameters:

Parameter	Type	Required	Default	Description
`dncListId`	string	Yes	—	DncList ID
`download`	string	No	—	Redirect to download uri

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dncListId": {
      "type": "string",
      "description": "DncList ID"
    },
    "download": {
      "type": "string",
      "description": "Redirect to download uri"
    }
  },
  "required": [
    "PCID",
    "dncListId"
  ]
}

genesys-outbound_get_dnclist_importstatus

Get dialer dncList import status. Parameters:

Parameter	Type	Required	Default	Description
`dncListId`	string	Yes	—	DncList ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dncListId": {
      "type": "string",
      "description": "DncList ID"
    }
  },
  "required": [
    "PCID",
    "dncListId"
  ]
}

genesys-outbound_get_dnclists

Query dialer DNC lists Parameters:

Parameter	Type	Required	Default	Description
`includeImportStatus`	boolean	No	—	Import status
`includeSize`	boolean	No	—	Include size
`pageSize`	integer	No	—	Page size. The max that will be returned is 100.
`pageNumber`	integer	No	—	Page number
`allowEmptyResult`	boolean	No	—	Whether to return an empty page when there are no results for that page
`filterType`	string	No	—	Filter type
`name`	string	No	—	The name value
`dncSourceType`	string	No	—	Dnc Source Type
`divisionId`	string[]	No	—	Division ID(s)
`sortBy`	string	No	—	Sort by
`sortOrder`	string	No	—	Sort order

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "includeImportStatus": {
      "type": "boolean",
      "description": "Import status"
    },
    "includeSize": {
      "type": "boolean",
      "description": "Include size"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size. The max that will be returned is 100."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "allowEmptyResult": {
      "type": "boolean",
      "description": "Whether to return an empty page when there are no results for that page"
    },
    "filterType": {
      "type": "string",
      "description": "Filter type",
      "enum": [
        "Equals",
        "RegEx",
        "Contains",
        "Prefix",
        "LessThan",
        "LessThanEqualTo",
        "GreaterThan",
        "GreaterThanEqualTo",
        "BeginsWith",
        "EndsWith"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "dncSourceType": {
      "type": "string",
      "description": "Dnc Source Type",
      "enum": [
        "rds",
        "rds_custom",
        "dnc.com",
        "gryphon"
      ]
    },
    "divisionId": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Division ID(s)"
    },
    "sortBy": {
      "type": "string",
      "description": "Sort by"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sort order",
      "enum": [
        "ascending",
        "descending"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_dnclists_divisionview

Get a basic DncList information object Parameters:

Parameter	Type	Required	Default	Description
`dncListId`	string	Yes	—	Dnclist ID
`includeImportStatus`	boolean	No	—	Include import status
`includeSize`	boolean	No	—	Include size

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dncListId": {
      "type": "string",
      "description": "Dnclist ID"
    },
    "includeImportStatus": {
      "type": "boolean",
      "description": "Include import status"
    },
    "includeSize": {
      "type": "boolean",
      "description": "Include size"
    }
  },
  "required": [
    "PCID",
    "dncListId"
  ]
}

genesys-outbound_get_dnclists_divisionviews

Query a list of simplified dnc list objects. Parameters:

Parameter	Type	Required	Default	Description
`includeImportStatus`	boolean	No	—	Include import status
`includeSize`	boolean	No	—	Include size
`pageSize`	integer	No	—	Page size. The max that will be returned is 100.
`pageNumber`	integer	No	—	Page number
`filterType`	string	No	—	Filter type
`name`	string	No	—	The name value
`dncSourceType`	string	No	—	Dnc Source Type
`id`	string[]	No	—	The id value
`sortBy`	string	No	—	Sort by
`sortOrder`	string	No	—	Sort order

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "includeImportStatus": {
      "type": "boolean",
      "description": "Include import status"
    },
    "includeSize": {
      "type": "boolean",
      "description": "Include size"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size. The max that will be returned is 100."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "filterType": {
      "type": "string",
      "description": "Filter type",
      "enum": [
        "Equals",
        "RegEx",
        "Contains",
        "Prefix",
        "LessThan",
        "LessThanEqualTo",
        "GreaterThan",
        "GreaterThanEqualTo",
        "BeginsWith",
        "EndsWith"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "dncSourceType": {
      "type": "string",
      "description": "Dnc Source Type",
      "enum": [
        "rds",
        "rds_custom",
        "dnc.com",
        "gryphon"
      ]
    },
    "id": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The id value"
    },
    "sortBy": {
      "type": "string",
      "description": "Sort by"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sort order",
      "enum": [
        "ascending",
        "descending"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_event

Get Dialer Event Parameters:

Parameter	Type	Required	Default	Description
`eventId`	string	Yes	—	Event Log ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "eventId": {
      "type": "string",
      "description": "Event Log ID"
    }
  },
  "required": [
    "PCID",
    "eventId"
  ]
}

genesys-outbound_get_events

Query Event Logs Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	Page size
`pageNumber`	integer	No	—	Page number
`filterType`	string	No	—	Filter type
`category`	string	No	—	The category value
`level`	string	No	—	The level value
`sortBy`	string	No	—	Sort by
`sortOrder`	string	No	—	Sort order

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "filterType": {
      "type": "string",
      "description": "Filter type",
      "enum": [
        "Equals",
        "RegEx",
        "Contains",
        "Prefix",
        "LessThan",
        "LessThanEqualTo",
        "GreaterThan",
        "GreaterThanEqualTo",
        "BeginsWith",
        "EndsWith"
      ]
    },
    "category": {
      "type": "string",
      "description": "The category value"
    },
    "level": {
      "type": "string",
      "description": "The level value"
    },
    "sortBy": {
      "type": "string",
      "description": "Sort by"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sort order",
      "enum": [
        "ascending",
        "descending"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_filespecificationtemplate

Get File Specification Template Parameters:

Parameter	Type	Required	Default	Description
`fileSpecificationTemplateId`	string	Yes	—	File Specification Template ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fileSpecificationTemplateId": {
      "type": "string",
      "description": "File Specification Template ID"
    }
  },
  "required": [
    "PCID",
    "fileSpecificationTemplateId"
  ]
}

genesys-outbound_get_filespecificationtemplates

Query File Specification Templates Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	Page size. The max that will be returned is 100.
`pageNumber`	integer	No	—	Page number
`allowEmptyResult`	boolean	No	—	Whether to return an empty page when there are no results for that page
`filterType`	string	No	—	Filter type
`name`	string	No	—	The name value
`sortBy`	string	No	—	Sort by
`sortOrder`	string	No	—	Sort order

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size. The max that will be returned is 100."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "allowEmptyResult": {
      "type": "boolean",
      "description": "Whether to return an empty page when there are no results for that page"
    },
    "filterType": {
      "type": "string",
      "description": "Filter type",
      "enum": [
        "Equals",
        "RegEx",
        "Contains",
        "Prefix",
        "LessThan",
        "LessThanEqualTo",
        "GreaterThan",
        "GreaterThanEqualTo",
        "BeginsWith",
        "EndsWith"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "sortBy": {
      "type": "string",
      "description": "Sort by"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sort order",
      "enum": [
        "ascending",
        "descending"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_importtemplate

Get Import Template Parameters:

Parameter	Type	Required	Default	Description
`importTemplateId`	string	Yes	—	Import Template ID
`includeImportStatus`	boolean	No	—	Import status

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "importTemplateId": {
      "type": "string",
      "description": "Import Template ID"
    },
    "includeImportStatus": {
      "type": "boolean",
      "description": "Import status"
    }
  },
  "required": [
    "PCID",
    "importTemplateId"
  ]
}

genesys-outbound_get_importtemplate_importstatus

Get the import status for an import template. Parameters:

Parameter	Type	Required	Default	Description
`importTemplateId`	string	Yes	—	Import Template Id
`listNamePrefix`	string	No	—	List Name Prefix

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "importTemplateId": {
      "type": "string",
      "description": "Import Template Id"
    },
    "listNamePrefix": {
      "type": "string",
      "description": "List Name Prefix"
    }
  },
  "required": [
    "PCID",
    "importTemplateId"
  ]
}

genesys-outbound_get_importtemplates

Query Import Templates Parameters:

Parameter	Type	Required	Default	Description
`includeImportStatus`	boolean	No	—	Import status
`pageSize`	integer	No	—	Page size. The max that will be returned is 100.
`pageNumber`	integer	No	—	Page number
`allowEmptyResult`	boolean	No	—	Whether to return an empty page when there are no results for that page
`filterType`	string	No	—	Filter type
`name`	string	No	—	The name value
`sortBy`	string	No	—	Sort by
`sortOrder`	string	No	—	Sort order
`contactListTemplateId`	string	No	—	Contact List Template ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "includeImportStatus": {
      "type": "boolean",
      "description": "Import status"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size. The max that will be returned is 100."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "allowEmptyResult": {
      "type": "boolean",
      "description": "Whether to return an empty page when there are no results for that page"
    },
    "filterType": {
      "type": "string",
      "description": "Filter type",
      "enum": [
        "Equals",
        "RegEx",
        "Contains",
        "Prefix",
        "LessThan",
        "LessThanEqualTo",
        "GreaterThan",
        "GreaterThanEqualTo",
        "BeginsWith",
        "EndsWith"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "sortBy": {
      "type": "string",
      "description": "Sort by"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sort order",
      "enum": [
        "ascending",
        "descending"
      ]
    },
    "contactListTemplateId": {
      "type": "string",
      "description": "Contact List Template ID"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_messagingcampaign

Get an Outbound Messaging Campaign Parameters:

Parameter	Type	Required	Default	Description
`messagingCampaignId`	string	Yes	—	The Messaging Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "messagingCampaignId": {
      "type": "string",
      "description": "The Messaging Campaign ID"
    }
  },
  "required": [
    "PCID",
    "messagingCampaignId"
  ]
}

genesys-outbound_get_messagingcampaign_diagnostics

Get messaging campaign diagnostics Parameters:

Parameter	Type	Required	Default	Description
`messagingCampaignId`	string	Yes	—	The Messaging Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "messagingCampaignId": {
      "type": "string",
      "description": "The Messaging Campaign ID"
    }
  },
  "required": [
    "PCID",
    "messagingCampaignId"
  ]
}

genesys-outbound_get_messagingcampaign_progress

Get messaging campaign’s progress Parameters:

Parameter	Type	Required	Default	Description
`messagingCampaignId`	string	Yes	—	The Messaging Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "messagingCampaignId": {
      "type": "string",
      "description": "The Messaging Campaign ID"
    }
  },
  "required": [
    "PCID",
    "messagingCampaignId"
  ]
}

genesys-outbound_get_messagingcampaigns

Query a list of Messaging Campaigns Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	Page size. The max that will be returned is 100.
`pageNumber`	integer	No	—	Page number
`sortBy`	string	No	—	The field to sort by
`sortOrder`	string	No	—	The direction to sort
`name`	string	No	—	The name value
`contactListId`	string	No	—	Contact List ID
`divisionId`	string[]	No	—	Division ID(s)
`type`	string	No	—	Campaign Type
`senderSmsPhoneNumber`	string	No	—	Sender SMS Phone Number
`id`	string[]	No	—	A list of messaging campaign ids to bulk fetch
`contentTemplateId`	string	No	—	Content template ID
`campaignStatus`	string	No	—	Campaign Status
`ruleSetIds`	string[]	No	—	Ruleset ID(s)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size. The max that will be returned is 100."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "sortBy": {
      "type": "string",
      "description": "The field to sort by",
      "enum": [
        "campaignStatus",
        "name",
        "type"
      ]
    },
    "sortOrder": {
      "type": "string",
      "description": "The direction to sort",
      "enum": [
        "ascending",
        "descending"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "contactListId": {
      "type": "string",
      "description": "Contact List ID"
    },
    "divisionId": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Division ID(s)"
    },
    "type": {
      "type": "string",
      "description": "Campaign Type",
      "enum": [
        "EMAIL",
        "SMS",
        "WHATSAPP"
      ]
    },
    "senderSmsPhoneNumber": {
      "type": "string",
      "description": "Sender SMS Phone Number"
    },
    "id": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of messaging campaign ids to bulk fetch"
    },
    "contentTemplateId": {
      "type": "string",
      "description": "Content template ID"
    },
    "campaignStatus": {
      "type": "string",
      "description": "Campaign Status",
      "enum": [
        "on",
        "stopping",
        "off",
        "complete",
        "invalid",
        "forced_off",
        "forced_stopping"
      ]
    },
    "ruleSetIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Ruleset ID(s)"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_messagingcampaigns_divisionview

Get a basic Messaging Campaign information object Parameters:

Parameter	Type	Required	Default	Description
`messagingCampaignId`	string	Yes	—	The Messaging Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "messagingCampaignId": {
      "type": "string",
      "description": "The Messaging Campaign ID"
    }
  },
  "required": [
    "PCID",
    "messagingCampaignId"
  ]
}

genesys-outbound_get_messagingcampaigns_divisionviews

Query a list of basic Messaging Campaign information objects Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	Page size. The max that will be returned is 100.
`pageNumber`	integer	No	—	Page number
`sortOrder`	string	No	—	The direction to sort
`name`	string	No	—	The name value
`type`	string	No	—	Campaign Type
`id`	string[]	No	—	The id value
`senderSmsPhoneNumber`	string	No	—	Sender SMS Phone Number
`contentTemplateId`	string	No	—	Content template ID
`campaignStatus`	string	No	—	Campaign Status

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size. The max that will be returned is 100."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "sortOrder": {
      "type": "string",
      "description": "The direction to sort",
      "enum": [
        "ascending",
        "descending"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "type": {
      "type": "string",
      "description": "Campaign Type",
      "enum": [
        "EMAIL",
        "SMS",
        "WHATSAPP"
      ]
    },
    "id": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The id value"
    },
    "senderSmsPhoneNumber": {
      "type": "string",
      "description": "Sender SMS Phone Number"
    },
    "contentTemplateId": {
      "type": "string",
      "description": "Content template ID"
    },
    "campaignStatus": {
      "type": "string",
      "description": "Campaign Status",
      "enum": [
        "on",
        "stopping",
        "off",
        "complete",
        "invalid",
        "forced_off",
        "forced_stopping"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_ruleset

Get a Rule Set by ID. Parameters:

Parameter	Type	Required	Default	Description
`ruleSetId`	string	Yes	—	Rule Set ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ruleSetId": {
      "type": "string",
      "description": "Rule Set ID"
    }
  },
  "required": [
    "PCID",
    "ruleSetId"
  ]
}

genesys-outbound_get_rulesets

Query a list of Rule Sets. Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	Page size. The max that will be returned is 100.
`pageNumber`	integer	No	—	Page number
`allowEmptyResult`	boolean	No	—	Whether to return an empty page when there are no results for that page
`filterType`	string	No	—	Filter type
`name`	string	No	—	The name value
`sortBy`	string	No	—	Sort by
`sortOrder`	string	No	—	Sort order

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size. The max that will be returned is 100."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "allowEmptyResult": {
      "type": "boolean",
      "description": "Whether to return an empty page when there are no results for that page"
    },
    "filterType": {
      "type": "string",
      "description": "Filter type",
      "enum": [
        "Equals",
        "RegEx",
        "Contains",
        "Prefix",
        "LessThan",
        "LessThanEqualTo",
        "GreaterThan",
        "GreaterThanEqualTo",
        "BeginsWith",
        "EndsWith"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "sortBy": {
      "type": "string",
      "description": "Sort by"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sort order",
      "enum": [
        "ascending",
        "descending"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_schedules_campaign

Get a dialer campaign schedule. Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	string	Yes	—	Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "string",
      "description": "Campaign ID"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

genesys-outbound_get_schedules_campaigns

Query for a list of dialer campaign schedules.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_schedules_emailcampaign

Get an email campaign schedule. Parameters:

Parameter	Type	Required	Default	Description
`emailCampaignId`	string	Yes	—	Email Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "emailCampaignId": {
      "type": "string",
      "description": "Email Campaign ID"
    }
  },
  "required": [
    "PCID",
    "emailCampaignId"
  ]
}

genesys-outbound_get_schedules_emailcampaigns

Query for a list of email campaign schedules.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_schedules_messagingcampaign

Get a messaging campaign schedule. Parameters:

Parameter	Type	Required	Default	Description
`messagingCampaignId`	string	Yes	—	Messaging Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "messagingCampaignId": {
      "type": "string",
      "description": "Messaging Campaign ID"
    }
  },
  "required": [
    "PCID",
    "messagingCampaignId"
  ]
}

genesys-outbound_get_schedules_messagingcampaigns

Query for a list of messaging campaign schedules.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_schedules_sequence

Get a dialer sequence schedule. Parameters:

Parameter	Type	Required	Default	Description
`sequenceId`	string	Yes	—	Sequence ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sequenceId": {
      "type": "string",
      "description": "Sequence ID"
    }
  },
  "required": [
    "PCID",
    "sequenceId"
  ]
}

genesys-outbound_get_schedules_sequences

Query for a list of dialer sequence schedules.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_schedules_whatsappcampaign

Get a WhatsApp campaign schedule. Parameters:

Parameter	Type	Required	Default	Description
`whatsAppCampaignId`	string	Yes	—	WhatsApp Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "whatsAppCampaignId": {
      "type": "string",
      "description": "WhatsApp Campaign ID"
    }
  },
  "required": [
    "PCID",
    "whatsAppCampaignId"
  ]
}

genesys-outbound_get_schedules_whatsappcampaigns

Query for a list of WhatsApp campaign schedules.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_sequence

Get a dialer campaign sequence. Parameters:

Parameter	Type	Required	Default	Description
`sequenceId`	string	Yes	—	Campaign Sequence ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sequenceId": {
      "type": "string",
      "description": "Campaign Sequence ID"
    }
  },
  "required": [
    "PCID",
    "sequenceId"
  ]
}

genesys-outbound_get_sequences

Query a list of dialer campaign sequences. Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	Page size. The max that will be returned is 100.
`pageNumber`	integer	No	—	Page number
`allowEmptyResult`	boolean	No	—	Whether to return an empty page when there are no results for that page
`filterType`	string	No	—	Filter type
`name`	string	No	—	The name value
`sortBy`	string	No	—	Sort by
`sortOrder`	string	No	—	Sort order

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size. The max that will be returned is 100."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "allowEmptyResult": {
      "type": "boolean",
      "description": "Whether to return an empty page when there are no results for that page"
    },
    "filterType": {
      "type": "string",
      "description": "Filter type",
      "enum": [
        "Equals",
        "RegEx",
        "Contains",
        "Prefix",
        "LessThan",
        "LessThanEqualTo",
        "GreaterThan",
        "GreaterThanEqualTo",
        "BeginsWith",
        "EndsWith"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "sortBy": {
      "type": "string",
      "description": "Sort by"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sort order",
      "enum": [
        "ascending",
        "descending"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_settings

Get the outbound settings for this organization

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_get_wrapupcodemappings

Get the Dialer wrap up code mapping.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_patch_campaign

Update a campaign. Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	string	Yes	—	Campaign ID
`abandonRate`	number	No	—	The targeted compliance abandon rate percentage
`dynamicLineBalancingSettings`	object	No	—	Dynamic Line Balancing Settings
`maxCallsPerAgent`	number	No	—	The maximum number of calls that can be placed per agent on this campaign
`outboundLineCount`	integer	No	—	The number of outbound lines to be concurrently dialed.
`queue`	object	No	—	The queue value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "string",
      "description": "Campaign ID"
    },
    "abandonRate": {
      "type": "number",
      "description": "The targeted compliance abandon rate percentage"
    },
    "dynamicLineBalancingSettings": {
      "type": "object",
      "description": "Dynamic Line Balancing Settings",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Indicates that this campaign is subject of dynamic line balancing"
        },
        "relativeWeight": {
          "type": "integer",
          "description": "Relative weight of this campaign in dynamic line balancing"
        }
      }
    },
    "maxCallsPerAgent": {
      "type": "number",
      "description": "The maximum number of calls that can be placed per agent on this campaign"
    },
    "outboundLineCount": {
      "type": "integer",
      "description": "The number of outbound lines to be concurrently dialed."
    },
    "queue": {
      "type": "object",
      "description": "The queue value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

genesys-outbound_patch_dnclist_customexclusioncolumns

Add entries to or delete entries from a DNC list. Parameters:

Parameter	Type	Required	Default	Description
`dncListId`	string	Yes	—	DncList ID
`action`	string	No	—	The action to perform
`customExclusionColumnEntries`	string[]	No	—	The list of custom exclusion column entries to Add to / Remove from the DNC list
`expirationDateTime`	string	No	—	Expiration date for DNC customExclusionColumnEntries in yyyy-MM-ddTHH:mmZ format

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dncListId": {
      "type": "string",
      "description": "DncList ID"
    },
    "action": {
      "type": "string",
      "description": "The action to perform",
      "enum": [
        "Add",
        "Remove"
      ]
    },
    "customExclusionColumnEntries": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of custom exclusion column entries to Add to / Remove from the DNC list"
    },
    "expirationDateTime": {
      "type": "string",
      "description": "Expiration date for DNC customExclusionColumnEntries in yyyy-MM-ddTHH:mmZ format"
    }
  },
  "required": [
    "PCID",
    "dncListId"
  ]
}

genesys-outbound_patch_dnclist_emailaddresses

Add emails to or Delete emails from a DNC list. Parameters:

Parameter	Type	Required	Default	Description
`dncListId`	string	Yes	—	DncList ID
`action`	string	No	—	The action to perform
`emailAddresses`	string[]	No	—	The list of email addresses to Add to / Remove from the DNC list
`expirationDateTime`	string	No	—	Expiration date for DNC email addresses in yyyy-MM-ddTHH:mmZ format

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dncListId": {
      "type": "string",
      "description": "DncList ID"
    },
    "action": {
      "type": "string",
      "description": "The action to perform",
      "enum": [
        "Add",
        "Remove"
      ]
    },
    "emailAddresses": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of email addresses to Add to / Remove from the DNC list"
    },
    "expirationDateTime": {
      "type": "string",
      "description": "Expiration date for DNC email addresses in yyyy-MM-ddTHH:mmZ format"
    }
  },
  "required": [
    "PCID",
    "dncListId"
  ]
}

genesys-outbound_patch_dnclist_phonenumbers

Add numbers to or delete numbers from a DNC list. Parameters:

Parameter	Type	Required	Default	Description
`dncListId`	string	Yes	—	DncList ID
`action`	string	No	—	The action to perform
`expirationDateTime`	string	No	—	Expiration date for DNC phone numbers in yyyy-MM-ddTHH:mmZ format
`phoneNumbers`	string[]	No	—	The list of phone numbers to Add to / Remove from the DNC list

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dncListId": {
      "type": "string",
      "description": "DncList ID"
    },
    "action": {
      "type": "string",
      "description": "The action to perform",
      "enum": [
        "Add",
        "Remove"
      ]
    },
    "expirationDateTime": {
      "type": "string",
      "description": "Expiration date for DNC phone numbers in yyyy-MM-ddTHH:mmZ format"
    },
    "phoneNumbers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of phone numbers to Add to / Remove from the DNC list"
    }
  },
  "required": [
    "PCID",
    "dncListId"
  ]
}

genesys-outbound_patch_dnclist_whatsappnumbers

Add entries to or delete entries from a DNC list. Parameters:

Parameter	Type	Required	Default	Description
`dncListId`	string	Yes	—	DncList ID
`action`	string	No	—	The action to perform
`expirationDateTime`	string	No	—	Expiration date for DNC whatsApp numbers in yyyy-MM-ddTHH:mmZ format
`whatsAppNumbers`	string[]	No	—	The list of whatsApp numbers to Add to / Remove from the DNC list

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dncListId": {
      "type": "string",
      "description": "DncList ID"
    },
    "action": {
      "type": "string",
      "description": "The action to perform",
      "enum": [
        "Add",
        "Remove"
      ]
    },
    "expirationDateTime": {
      "type": "string",
      "description": "Expiration date for DNC whatsApp numbers in yyyy-MM-ddTHH:mmZ format"
    },
    "whatsAppNumbers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of whatsApp numbers to Add to / Remove from the DNC list"
    }
  },
  "required": [
    "PCID",
    "dncListId"
  ]
}

genesys-outbound_patch_settings

Update the outbound settings for this organization Parameters:

Parameter	Type	Required	Default	Description
`useMaxCallsPerAgentDecimal`	boolean	No	—	Use maxCallsPerAgent with decimal precision
`abandonSeconds`	number	No	—	The number of seconds used to determine if a call is abandoned
`automaticTimeZoneMapping`	object	No	—	Automatic Time Zone Mapping
`complianceAbandonRateDenominator`	string	No	—	The denominator to be used in determining the compliance abandon rate
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`id`	string	No	—	The globally unique identifier for the object.
`maxCallsPerAgent`	integer	No	—	The maximum number of calls that can be placed per agent on any campaign
`maxCallsPerAgentDecimal`	number	No	—	The maximum number of calls that can be placed per agent on any campaign with decimal precision
`maxConfigurableCallsPerAgent`	integer	No	—	The maximum number of calls that can be configured to be placed per agent on any campaign
`maxLineUtilization`	number	No	—	The maximum percentage of lines that should be used for Outbound, expressed as a decimal in the range [0.0, 1.0]
`name`	string	No	—	The name value
`rescheduleTimeZoneSkippedContacts`	boolean	No	—	Whether or not to reschedule time-zone blocked contacts
`selfUri`	string	No	—	The URI for this object
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "useMaxCallsPerAgentDecimal": {
      "type": "boolean",
      "description": "Use maxCallsPerAgent with decimal precision",
      "enum": [
        true,
        false
      ]
    },
    "abandonSeconds": {
      "type": "number",
      "description": "The number of seconds used to determine if a call is abandoned"
    },
    "automaticTimeZoneMapping": {
      "type": "object",
      "description": "Automatic Time Zone Mapping",
      "properties": {
        "callableWindows": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The time intervals to use for automatic time zone mapping."
        },
        "supportedCountries": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The countries that are supported for automatic time zone mapping."
        }
      }
    },
    "complianceAbandonRateDenominator": {
      "type": "string",
      "description": "The denominator to be used in determining the compliance abandon rate",
      "enum": [
        "ALL_CALLS",
        "CALLS_THAT_REACHED_QUEUE"
      ]
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "maxCallsPerAgent": {
      "type": "integer",
      "description": "The maximum number of calls that can be placed per agent on any campaign"
    },
    "maxCallsPerAgentDecimal": {
      "type": "number",
      "description": "The maximum number of calls that can be placed per agent on any campaign with decimal precision"
    },
    "maxConfigurableCallsPerAgent": {
      "type": "integer",
      "description": "The maximum number of calls that can be configured to be placed per agent on any campaign"
    },
    "maxLineUtilization": {
      "type": "number",
      "description": "The maximum percentage of lines that should be used for Outbound, expressed as a decimal in the range [0.0, 1.0]"
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "rescheduleTimeZoneSkippedContacts": {
      "type": "boolean",
      "description": "Whether or not to reschedule time-zone blocked contacts"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_post_attemptlimits

Create attempt limits Parameters:

Parameter	Type	Required	Default	Description
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`id`	string	No	—	The globally unique identifier for the object.
`maxAttemptsPerContact`	integer	No	—	The maximum number of times a contact can be called within the resetPeriod. Required if maxAttemptsPerNumber is not defined.
`maxAttemptsPerNumber`	integer	No	—	The maximum number of times a phone number can be called within the resetPeriod. Required if maxAttemptsPerContact is not defined.
`name`	string	No	—	The name value
`recallEntries`	object	No	—	Configuration for recall attempts.
`resetPeriod`	string	No	—	After how long the number of attempts will be set back to 0. Defaults to NEVER.
`selfUri`	string	No	—	The URI for this object
`timeZoneId`	string	No	—	If the resetPeriod is TODAY, this specifies the timezone in which TODAY occurs. Required if the resetPeriod is TODAY. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "maxAttemptsPerContact": {
      "type": "integer",
      "description": "The maximum number of times a contact can be called within the resetPeriod. Required if maxAttemptsPerNumber is not defined."
    },
    "maxAttemptsPerNumber": {
      "type": "integer",
      "description": "The maximum number of times a phone number can be called within the resetPeriod. Required if maxAttemptsPerContact is not defined."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "recallEntries": {
      "type": "object",
      "description": "Configuration for recall attempts."
    },
    "resetPeriod": {
      "type": "string",
      "description": "After how long the number of attempts will be set back to 0. Defaults to NEVER.",
      "enum": [
        "NEVER",
        "TODAY",
        "DAYS_2",
        "DAYS_3",
        "DAYS_4",
        "DAYS_5",
        "DAYS_6",
        "DAYS_7",
        "DAYS_8",
        "DAYS_9",
        "DAYS_10",
        "DAYS_11",
        "DAYS_12",
        "DAYS_13",
        "DAYS_14",
        "DAYS_15",
        "DAYS_16",
        "DAYS_17",
        "DAYS_18",
        "DAYS_19",
        "DAYS_20",
        "DAYS_21",
        "DAYS_22",
        "DAYS_23",
        "DAYS_24",
        "DAYS_25",
        "DAYS_26",
        "DAYS_27",
        "DAYS_28",
        "DAYS_29",
        "DAYS_30"
      ]
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "timeZoneId": {
      "type": "string",
      "description": "If the resetPeriod is TODAY, this specifies the timezone in which TODAY occurs. Required if the resetPeriod is TODAY. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-outbound_post_callabletimesets

Create callable time set Parameters:

Parameter	Type	Required	Default	Description
`callableTimes`	object[]	Yes	—	The list of CallableTimes for which it is acceptable to place outbound calls.
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`id`	string	No	—	The globally unique identifier for the object.
`name`	string	Yes	—	The name of the CallableTimeSet.
`selfUri`	string	No	—	The URI for this object
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "callableTimes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "timeSlots": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "startTime": {
                  "type": "string",
                  "description": "The start time of the interval as an ISO-8601 string, i.e. HH:mm:ss"
                },
                "stopTime": {
                  "type": "string",
                  "description": "The end time of the interval as an ISO-8601 string, i.e. HH:mm:ss"
                },
                "day": {
                  "type": "integer",
                  "description": "The day of the interval. Valid values: [1-7], representing Monday through Sunday"
                }
              }
            },
            "description": "The time intervals for which it is acceptable to place outbound calls."
          },
          "name": {
            "type": "string",
            "description": "The name for the callable time."
          },
          "timeZoneId": {
            "type": "string",
            "description": "The time zone for the time slots; for example, Africa/Abidjan. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
          }
        },
        "required": [
          "timeSlots",
          "timeZoneId"
        ]
      },
      "description": "The list of CallableTimes for which it is acceptable to place outbound calls."
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "name": {
      "type": "string",
      "description": "The name of the CallableTimeSet."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "callableTimes",
    "name"
  ]
}

genesys-outbound_post_callanalysisresponsesets

Create a dialer call analysis response set. Parameters:

Parameter	Type	Required	Default	Description
`amdSpeechDistinguishEnabled`	boolean	No	—	Whether to enable answering machine detection
`beepDetectionEnabled`	boolean	No	—	Whether to enable answering machine beep detection
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`id`	string	No	—	The globally unique identifier for the object.
`liveSpeakerDetectionMode`	string	No	—	Setting level of live speaker detection based on ringbacks
`name`	string	Yes	—	The name of the ResponseSet.
`responses`	object	Yes	—	Map of disposition identifiers to reactions. For example: {“disposition.classification.callable.person”: {“reactionType”: “transfer”}}.
`selfUri`	string	No	—	The URI for this object
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "amdSpeechDistinguishEnabled": {
      "type": "boolean",
      "description": "Whether to enable answering machine detection"
    },
    "beepDetectionEnabled": {
      "type": "boolean",
      "description": "Whether to enable answering machine beep detection"
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "liveSpeakerDetectionMode": {
      "type": "string",
      "description": "Setting level of live speaker detection based on ringbacks",
      "enum": [
        "Disabled",
        "Low",
        "Medium",
        "High"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name of the ResponseSet."
    },
    "responses": {
      "type": "object",
      "description": "Map of disposition identifiers to reactions. For example: {\"disposition.classification.callable.person\": {\"reactionType\": \"transfer\"}}."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "name",
    "responses"
  ]
}

genesys-outbound_post_campaign_agentownedmappingpreview

Initiate request for a preview of how agents will be mapped to this campaign’s contact list. Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	string	Yes	—	Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "string",
      "description": "Campaign ID"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

genesys-outbound_post_campaign_start

Start the campaign Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	string	Yes	—	Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "string",
      "description": "Campaign ID"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

genesys-outbound_post_campaign_stop

Stop the campaign Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	string	Yes	—	Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "string",
      "description": "Campaign ID"
    }
  },
  "required": [
    "PCID",
    "campaignId"
  ]
}

genesys-outbound_post_campaignrules

Create Campaign Rule Parameters:

Parameter	Type	Required	Default	Description
`campaignRuleActions`	object[]	Yes	—	The list of actions that are executed if the conditions are satisfied.
`campaignRuleConditions`	object[]	Yes	—	The list of conditions that are evaluated on the entities.
`campaignRuleEntities`	object	Yes	—	Campaign Rule Entities
`campaignRuleProcessing`	string	No	—	CampaignRule processing algorithm
`conditionGroups`	object[]	No	—	List of condition groups that are evaluated, used only with campaignRuleProcessing=“v2”
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`enabled`	boolean	No	—	Whether or not this CampaignRule is currently enabled. Required on updates.
`executionSettings`	object	No	—	Execution Settings
`id`	string	No	—	The globally unique identifier for the object.
`matchAnyConditions`	boolean	No	—	Match Any Conditions
`name`	string	Yes	—	The name of the CampaignRule.
`selfUri`	string	No	—	The URI for this object
`timeZoneId`	string	No	—	The time zone to use for date-time conditions.
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update
`warnings`	object[]	No	—	A list of current warning conditions associated with the campaign rule.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignRuleActions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "parameters": {
            "type": "object",
            "description": "The parameters value"
          },
          "actionType": {
            "type": "string",
            "enum": [
              "turnOnCampaign",
              "turnOffCampaign",
              "turnOnSequence",
              "turnOffSequence",
              "setCampaignPriority",
              "recycleCampaign",
              "setCampaignDialingMode",
              "setCampaignAbandonRate",
              "setCampaignNumberOfLines",
              "setCampaignWeight",
              "setCampaignMaxCallsPerAgent",
              "setCampaignMessagesPerMinute",
              "changeCampaignQueue",
              "changeCampaignTemplate"
            ],
            "description": "The action to take on the campaignRuleActionEntities."
          },
          "campaignRuleActionEntities": {
            "type": "object",
            "description": "Campaign Rule Action Entities"
          }
        },
        "required": [
          "actionType",
          "campaignRuleActionEntities"
        ]
      },
      "description": "The list of actions that are executed if the conditions are satisfied."
    },
    "campaignRuleConditions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "parameters": {
            "type": "object",
            "description": "The parameters value"
          },
          "conditionType": {
            "type": "string",
            "enum": [
              "campaignProgress",
              "campaignAgents",
              "campaignRecordsAttempted",
              "campaignContactsMessaged",
              "campaignBusinessSuccess",
              "campaignBusinessFailure",
              "campaignBusinessNeutral",
              "campaignValidAttempts",
              "campaignRightPartyContacts",
              "timeOfDay",
              "dayOfWeek",
              "dayOfMonth",
              "weekDayOfMonth",
              "specificDate",
              "campaignRunTime",
              "campaignWaitTime"
            ],
            "description": "The type of condition to evaluate."
          },
          "dateTimeParameters": {
            "type": "object",
            "description": "Date Time Parameters"
          },
          "campaignRunTimeSettings": {
            "type": "object",
            "description": "Campaign Run Time Settings"
          },
          "campaignWaitTimeSettings": {
            "type": "object",
            "description": "Campaign Wait Time Settings"
          }
        },
        "required": [
          "conditionType",
          "parameters"
        ]
      },
      "description": "The list of conditions that are evaluated on the entities."
    },
    "campaignRuleEntities": {
      "type": "object",
      "description": "Campaign Rule Entities",
      "properties": {
        "campaigns": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The list of campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a campaign."
        },
        "sequences": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The list of sequences for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a sequence."
        },
        "emailCampaigns": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The list of Email campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a Email campaign."
        },
        "smsCampaigns": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The list of SMS campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a SMS campaign."
        }
      }
    },
    "campaignRuleProcessing": {
      "type": "string",
      "description": "CampaignRule processing algorithm",
      "enum": [
        "v2"
      ]
    },
    "conditionGroups": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "matchAnyConditions": {
            "type": "boolean",
            "description": "Whether or not this condition group should be evaluated as true if any of sub conditions is matched"
          },
          "conditions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "parameters": {
                  "type": "object"
                },
                "conditionType": {
                  "type": "string",
                  "description": "The type of condition to evaluate."
                },
                "dateTimeParameters": {
                  "type": "object"
                },
                "campaignRunTimeSettings": {
                  "type": "object"
                },
                "campaignWaitTimeSettings": {
                  "type": "object"
                }
              }
            },
            "description": "The parameters for the CampaignRuleCondition."
          }
        },
        "required": [
          "conditions",
          "matchAnyConditions"
        ]
      },
      "description": "List of condition groups that are evaluated, used only with campaignRuleProcessing=\"v2\""
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether or not this CampaignRule is currently enabled. Required on updates."
    },
    "executionSettings": {
      "type": "object",
      "description": "Execution Settings",
      "properties": {
        "frequency": {
          "type": "string",
          "description": "Execution control frequency",
          "enum": [
            "onEachTrigger",
            "oncePerDay"
          ]
        },
        "timeZoneId": {
          "type": "string",
          "description": "The time zone for the execution control frequency=\"oncePerDay\"; for example, Africa/Abidjan. This property is ignored when frequency is not \"oncePerDay\""
        }
      },
      "required": [
        "frequency"
      ]
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "matchAnyConditions": {
      "type": "boolean",
      "description": "Match Any Conditions"
    },
    "name": {
      "type": "string",
      "description": "The name of the CampaignRule."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "timeZoneId": {
      "type": "string",
      "description": "The time zone to use for date-time conditions."
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "enum": [
              "ConditionsNoEntities",
              "ConditionsNoSequences",
              "ConditionsNoCampaigns",
              "ConditionsNoMessagingCampaigns",
              "ActionNoEntities",
              "ActionNoSequences",
              "ActionNoCampaigns",
              "ActionNoMessagingCampaigns",
              "NoQueue",
              "NoContentTemplates",
              "NoSmsContentTemplate",
              "NoEmailContentTemplate",
              "ConditionsWaitingForLinesOnlyPreviewOrExternal",
              "ConditionsWaitingForAgentsOnlyAgentless"
            ],
            "description": "Warning code for this warning."
          },
          "message": {
            "type": "string",
            "description": "Warning message for this warning."
          },
          "params": {
            "type": "object",
            "description": "The params value"
          }
        },
        "required": [
          "code",
          "message"
        ]
      },
      "description": "A list of current warning conditions associated with the campaign rule."
    }
  },
  "required": [
    "PCID",
    "campaignRuleActions",
    "campaignRuleConditions",
    "campaignRuleEntities",
    "name"
  ]
}

genesys-outbound_post_campaigns

Create a campaign. Parameters:

Parameter	Type	Required	Default	Description
`useMaxCallsPerAgentDecimal`	boolean	No	—	Use maxCallsPerAgent with decimal precision
`abandonRate`	number	No	—	The targeted compliance abandon rate percentage. Required for power and predictive campaigns.
`agentOwnedColumn`	string	No	—	Name of the contact list column containing the id of the agent who owns the record. Only applicable to preview campaigns.
`alwaysRunning`	boolean	No	—	Indicates (when true) that the campaign will remain on after contacts are depleted, allowing additional contacts to be appended/added to the contact list and processed by the still-running campaign. The campaign can still be turned off manually.
`callableTimeSet`	object	No	—	Callable Time Set
`callAnalysisLanguage`	string	No	—	The language the edge will use to analyze the call.
`callAnalysisResponseSet`	object	No	—	Call Analysis Response Set
`callbackAutoAnswer`	boolean	No	—	The option manages the auto-answer callback calls
`callerAddress`	string	Yes	—	The caller id phone number to be displayed on the outbound call.
`callerName`	string	Yes	—	The caller id name to be displayed on the outbound call.
`campaignStatus`	string	No	—	The current status of the Campaign. A Campaign may be turned ‘on’ or ‘off’. Required for updates.
`contactList`	object	Yes	—	Contact List
`contactListFilters`	object[]	No	—	Filter to apply to the contact list before dialing. Currently a campaign can only have one filter applied.
`contactSort`	object	No	—	Contact Sort
`contactSorts`	object[]	No	—	The order in which to sort contacts for dialing, based on up to four columns.
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`diagnosticsSettings`	object	No	—	Diagnostics Settings
`dialingMode`	string	Yes	—	The strategy this Campaign will use for dialing.
`division`	object	No	—	The division value
`dncLists`	object[]	No	—	DncLists for this Campaign to check before placing a call.
`dynamicContactQueueingSettings`	object	No	—	Dynamic Contact Queueing Settings
`dynamicLineBalancingSettings`	object	No	—	Dynamic Line Balancing Settings
`edgeGroup`	object	No	—	Edge Group
`errors`	object[]	No	—	A list of current error conditions associated with the campaign.
`id`	string	No	—	The globally unique identifier for the object.
`maxCallsPerAgent`	integer	No	—	The maximum number of calls that can be placed per agent on this campaign
`maxCallsPerAgentDecimal`	number	No	—	The maximum number of calls that can be placed per agent on this campaign with decimal precision
`name`	string	Yes	—	The name of the Campaign.
`noAnswerTimeout`	integer	No	—	How long to wait before dispositioning a call as ‘no-answer’. Default 30 seconds. Only applicable to non-preview campaigns.
`outboundLineCount`	integer	No	—	The number of outbound lines to be concurrently dialed. Only applicable to non-preview campaigns; only required for agentless.
`phoneColumns`	object[]	Yes	—	The ContactPhoneNumberColumns on the ContactList that this Campaign should dial.
`previewAutoEnd`	boolean	No	—	Option to enable preview auto end
`previewTimeOutSeconds`	integer	No	—	The number of seconds before a call will be automatically placed on a preview. A value of 0 indicates no automatic placement of calls. Only applicable to preview campaigns.
`priority`	integer	No	—	The priority of this campaign relative to other campaigns that are running on the same queue. 5 is the highest priority, 1 the lowest.
`queue`	object	No	—	The queue value
`ruleSets`	object[]	No	—	Rule sets to be applied while this campaign is dialing.
`script`	object	No	—	The script value
`selfUri`	string	No	—	The URI for this object
`site`	object	No	—	The site value
`skillColumns`	string[]	No	—	The skill columns on the ContactList that this Campaign should take into account when dialing
`skipPreviewDisabled`	boolean	No	—	Whether or not agents can skip previews without placing a call. Only applicable for preview campaigns.
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "useMaxCallsPerAgentDecimal": {
      "type": "boolean",
      "description": "Use maxCallsPerAgent with decimal precision",
      "enum": [
        true,
        false
      ]
    },
    "abandonRate": {
      "type": "number",
      "description": "The targeted compliance abandon rate percentage. Required for power and predictive campaigns."
    },
    "agentOwnedColumn": {
      "type": "string",
      "description": "Name of the contact list column containing the id of the agent who owns the record. Only applicable to preview campaigns."
    },
    "alwaysRunning": {
      "type": "boolean",
      "description": "Indicates (when true) that the campaign will remain on after contacts are depleted, allowing additional contacts to be appended/added to the contact list and processed by the still-running campaign. The campaign can still be turned off manually."
    },
    "callableTimeSet": {
      "type": "object",
      "description": "Callable Time Set",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "callAnalysisLanguage": {
      "type": "string",
      "description": "The language the edge will use to analyze the call."
    },
    "callAnalysisResponseSet": {
      "type": "object",
      "description": "Call Analysis Response Set",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "callbackAutoAnswer": {
      "type": "boolean",
      "description": "The option manages the auto-answer callback calls"
    },
    "callerAddress": {
      "type": "string",
      "description": "The caller id phone number to be displayed on the outbound call."
    },
    "callerName": {
      "type": "string",
      "description": "The caller id name to be displayed on the outbound call."
    },
    "campaignStatus": {
      "type": "string",
      "description": "The current status of the Campaign. A Campaign may be turned 'on' or 'off'. Required for updates.",
      "enum": [
        "on",
        "stopping",
        "off",
        "complete",
        "invalid",
        "forced_off",
        "forced_stopping"
      ]
    },
    "contactList": {
      "type": "object",
      "description": "Contact List",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "contactListFilters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "name": {
            "type": "string",
            "description": "The name value"
          },
          "selfUri": {
            "type": "string",
            "format": "uri",
            "description": "Self Uri"
          }
        }
      },
      "description": "Filter to apply to the contact list before dialing. Currently a campaign can only have one filter applied."
    },
    "contactSort": {
      "type": "object",
      "description": "Contact Sort",
      "properties": {
        "fieldName": {
          "type": "string",
          "description": "Field Name"
        },
        "direction": {
          "type": "string",
          "description": "The direction in which to sort contacts.",
          "enum": [
            "ASC",
            "DESC"
          ]
        },
        "numeric": {
          "type": "boolean",
          "description": "Whether or not the column contains numeric data."
        }
      }
    },
    "contactSorts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "fieldName": {
            "type": "string",
            "description": "Field Name"
          },
          "direction": {
            "type": "string",
            "enum": [
              "ASC",
              "DESC"
            ],
            "description": "The direction in which to sort contacts."
          },
          "numeric": {
            "type": "boolean",
            "description": "Whether or not the column contains numeric data."
          }
        }
      },
      "description": "The order in which to sort contacts for dialing, based on up to four columns."
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "diagnosticsSettings": {
      "type": "object",
      "description": "Diagnostics Settings",
      "properties": {
        "reportLowMaxCallsPerAgentAlert": {
          "type": "boolean",
          "description": "Whether to report on low max calls per agent alerts."
        }
      }
    },
    "dialingMode": {
      "type": "string",
      "description": "The strategy this Campaign will use for dialing.",
      "enum": [
        "agentless",
        "preview",
        "power",
        "predictive",
        "progressive",
        "external"
      ]
    },
    "division": {
      "type": "object",
      "description": "The division value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "dncLists": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "name": {
            "type": "string",
            "description": "The name value"
          },
          "selfUri": {
            "type": "string",
            "format": "uri",
            "description": "Self Uri"
          }
        }
      },
      "description": "DncLists for this Campaign to check before placing a call."
    },
    "dynamicContactQueueingSettings": {
      "type": "object",
      "description": "Dynamic Contact Queueing Settings",
      "properties": {
        "sort": {
          "type": "boolean",
          "description": "Whether to sort contacts dynamically"
        },
        "filter": {
          "type": "boolean",
          "description": "Whether to filter contacts dynamically"
        }
      }
    },
    "dynamicLineBalancingSettings": {
      "type": "object",
      "description": "Dynamic Line Balancing Settings",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Indicates that this campaign is subject of dynamic line balancing"
        },
        "relativeWeight": {
          "type": "integer",
          "description": "Relative weight of this campaign in dynamic line balancing"
        }
      }
    },
    "edgeGroup": {
      "type": "object",
      "description": "Edge Group",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "description": "name of the error"
          },
          "details": {
            "type": "string",
            "description": "additional information regarding the error"
          },
          "userParams": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            },
            "description": "parameters to be inserted into details."
          }
        },
        "required": [
          "error"
        ]
      },
      "description": "A list of current error conditions associated with the campaign."
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "maxCallsPerAgent": {
      "type": "integer",
      "description": "The maximum number of calls that can be placed per agent on this campaign"
    },
    "maxCallsPerAgentDecimal": {
      "type": "number",
      "description": "The maximum number of calls that can be placed per agent on this campaign with decimal precision"
    },
    "name": {
      "type": "string",
      "description": "The name of the Campaign."
    },
    "noAnswerTimeout": {
      "type": "integer",
      "description": "How long to wait before dispositioning a call as 'no-answer'. Default 30 seconds. Only applicable to non-preview campaigns."
    },
    "outboundLineCount": {
      "type": "integer",
      "description": "The number of outbound lines to be concurrently dialed. Only applicable to non-preview campaigns; only required for agentless."
    },
    "phoneColumns": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "columnName": {
            "type": "string",
            "description": "The name of the phone column."
          },
          "type": {
            "type": "string",
            "description": "The type of the phone column. For example, 'cell' or 'home'."
          }
        },
        "required": [
          "columnName",
          "type"
        ]
      },
      "description": "The ContactPhoneNumberColumns on the ContactList that this Campaign should dial."
    },
    "previewAutoEnd": {
      "type": "boolean",
      "description": "Option to enable preview auto end"
    },
    "previewTimeOutSeconds": {
      "type": "integer",
      "description": "The number of seconds before a call will be automatically placed on a preview. A value of 0 indicates no automatic placement of calls. Only applicable to preview campaigns."
    },
    "priority": {
      "type": "integer",
      "description": "The priority of this campaign relative to other campaigns that are running on the same queue. 5 is the highest priority, 1 the lowest."
    },
    "queue": {
      "type": "object",
      "description": "The queue value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "ruleSets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "name": {
            "type": "string",
            "description": "The name value"
          },
          "selfUri": {
            "type": "string",
            "format": "uri",
            "description": "Self Uri"
          }
        }
      },
      "description": "Rule sets to be applied while this campaign is dialing."
    },
    "script": {
      "type": "object",
      "description": "The script value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "site": {
      "type": "object",
      "description": "The site value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "skillColumns": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The skill columns on the ContactList that this Campaign should take into account when dialing"
    },
    "skipPreviewDisabled": {
      "type": "boolean",
      "description": "Whether or not agents can skip previews without placing a call. Only applicable for preview campaigns."
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "callerAddress",
    "callerName",
    "contactList",
    "dialingMode",
    "name",
    "phoneColumns"
  ]
}

genesys-outbound_post_campaigns_performance_query

Get performance data for a list of campaigns Parameters:

Parameter	Type	Required	Default	Description
`body`	string[]	Yes	—	Campaign IDs. Maximum of 50 IDs allowed.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "body": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Campaign IDs. Maximum of 50 IDs allowed."
    }
  },
  "required": [
    "PCID",
    "body"
  ]
}

genesys-outbound_post_campaigns_progress

Get progress for a list of campaigns Parameters:

Parameter	Type	Required	Default	Description
`body`	string[]	Yes	—	Campaign IDs

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "body": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Campaign IDs"
    }
  },
  "required": [
    "PCID",
    "body"
  ]
}

genesys-outbound_post_contactlist_clear

Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled. Parameters:

Parameter	Type	Required	Default	Description
`contactListId`	string	Yes	—	Contact List ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListId": {
      "type": "string",
      "description": "Contact List ID"
    }
  },
  "required": [
    "PCID",
    "contactListId"
  ]
}

genesys-outbound_post_contactlist_contacts

Add contacts to a contact list. Parameters:

Parameter	Type	Required	Default	Description
`contactListId`	string	Yes	—	Contact List ID
`priority`	boolean	No	—	Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue.
`clearSystemData`	boolean	No	—	Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won’t.
`doNotQueue`	boolean	No	—	Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts, this parameter has no effect; False means that updated contacts will be re-queued, according to the ‘priority’ parameter.
`body`	object[]	Yes	—	Contact

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListId": {
      "type": "string",
      "description": "Contact List ID"
    },
    "priority": {
      "type": "boolean",
      "description": "Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue."
    },
    "clearSystemData": {
      "type": "boolean",
      "description": "Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won't."
    },
    "doNotQueue": {
      "type": "boolean",
      "description": "Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts, this parameter has no effect; False means that updated contacts will be re-queued, according to the 'priority' parameter."
    },
    "body": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The globally unique identifier for the object."
          },
          "contactListId": {
            "type": "string",
            "description": "The identifier of the contact list containing this contact."
          },
          "data": {
            "type": "object",
            "description": "An ordered map of the contact's columns and corresponding values."
          },
          "latestSmsEvaluations": {
            "type": "object",
            "description": "A map of SMS records for the contact phone columns."
          },
          "latestEmailEvaluations": {
            "type": "object",
            "description": "A map of email records for the contact email columns."
          },
          "latestWhatsAppEvaluations": {
            "type": "object",
            "description": "A map of whatsapp records for the contact whatsapp columns."
          },
          "callable": {
            "type": "boolean",
            "description": "Indicates whether or not the contact can be called."
          },
          "phoneNumberStatus": {
            "type": "object",
            "description": "A map of phone number columns to PhoneNumberStatuses, which indicate if the phone number is callable or not."
          },
          "contactableStatus": {
            "type": "object",
            "description": "A map of media types (Voice, SMS and Email) to ContactableStatus, which indicates if the contact can be contacted using the specified media type."
          },
          "dateCreated": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp for when the contact was added. Contacts added prior to 2023 September 1 may be missing this value. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
          }
        },
        "required": [
          "contactListId",
          "data"
        ]
      },
      "description": "Contact"
    }
  },
  "required": [
    "PCID",
    "contactListId",
    "body"
  ]
}

genesys-outbound_post_contactlist_contacts_bulk

Get contacts from a contact list. Parameters:

Parameter	Type	Required	Default	Description
`contactListId`	string	Yes	—	Contact List ID
`body`	string[]	Yes	—	ContactIds to get.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListId": {
      "type": "string",
      "description": "Contact List ID"
    },
    "body": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "ContactIds to get."
    }
  },
  "required": [
    "PCID",
    "contactListId",
    "body"
  ]
}

genesys-outbound_post_contactlist_contacts_bulk_remove

Start an async job to delete contacts using a filter. Parameters:

Parameter	Type	Required	Default	Description
`contactListId`	string	Yes	—	Contact List ID
`contactListFilterId`	string	No	—	Contact List Filter ID. Either this property or criteria is required.
`criteria`	object	No	—	The criteria value
`generateDownloadURI`	boolean	No	—	Whether to do backup export as part of Bulk Operation or not. Default: true.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListId": {
      "type": "string",
      "description": "Contact List ID"
    },
    "contactListFilterId": {
      "type": "string",
      "description": "Contact List Filter ID. Either this property or criteria is required."
    },
    "criteria": {
      "type": "object",
      "description": "The criteria value",
      "properties": {
        "clauses": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Groups of conditions to filter the contacts by."
        },
        "filterType": {
          "type": "string",
          "description": "How to join clauses together.",
          "enum": [
            "AND",
            "OR"
          ]
        }
      }
    },
    "generateDownloadURI": {
      "type": "boolean",
      "description": "Whether to do backup export as part of Bulk Operation or not. Default: true."
    }
  },
  "required": [
    "PCID",
    "contactListId"
  ]
}

genesys-outbound_post_contactlist_contacts_bulk_update

Start an async job to bulk edit contacts. Parameters:

Parameter	Type	Required	Default	Description
`contactListId`	string	Yes	—	Contact List ID
`contact`	object	No	—	The contact value
`contactIds`	string[]	No	—	Contact IDs to be bulk edited.
`contactListFilterId`	string	No	—	Contact List Filter ID.
`criteria`	object	No	—	The criteria value
`generateDownloadURI`	boolean	No	—	Whether to do backup export as part of Bulk Operation or not. Default: true.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListId": {
      "type": "string",
      "description": "Contact List ID"
    },
    "contact": {
      "type": "object",
      "description": "The contact value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The globally unique identifier for the object."
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "contactListId": {
          "type": "string",
          "description": "The identifier of the contact list containing this contact."
        },
        "data": {
          "type": "object",
          "description": "An ordered map of the contact's columns and corresponding values."
        },
        "callRecords": {
          "type": "object",
          "description": "A map of call records for the contact phone columns."
        },
        "latestSmsEvaluations": {
          "type": "object",
          "description": "A map of SMS records for the contact phone columns."
        },
        "latestEmailEvaluations": {
          "type": "object",
          "description": "A map of email records for the contact email columns."
        },
        "latestWhatsAppEvaluations": {
          "type": "object",
          "description": "A map of whatsapp records for the contact whatsapp columns."
        },
        "callable": {
          "type": "boolean",
          "description": "Indicates whether or not the contact can be called."
        },
        "phoneNumberStatus": {
          "type": "object",
          "description": "A map of phone number columns to PhoneNumberStatuses, which indicate if the phone number is callable or not."
        },
        "contactableStatus": {
          "type": "object",
          "description": "A map of media types (Voice, SMS and Email) to ContactableStatus, which indicates if the contact can be contacted using the specified media type."
        },
        "contactColumnTimeZones": {
          "type": "object",
          "description": "Map containing data about the timezone the contact is mapped to. This will only be populated if the contact list has automatic timezone mapping turned on. The key is the column name. The value is the timezone it mapped to and the type of column: Phone or Zip"
        },
        "configurationOverrides": {
          "type": "object",
          "description": "Configuration Overrides"
        },
        "dateCreated": {
          "type": "string",
          "description": "Timestamp for when the contact was added. Contacts added prior to 2023 September 1 may be missing this value. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
        },
        "selfUri": {
          "type": "string",
          "description": "The URI for this object"
        }
      },
      "required": [
        "contactListId",
        "data"
      ]
    },
    "contactIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Contact IDs to be bulk edited."
    },
    "contactListFilterId": {
      "type": "string",
      "description": "Contact List Filter ID."
    },
    "criteria": {
      "type": "object",
      "description": "The criteria value",
      "properties": {
        "clauses": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Groups of conditions to filter the contacts by."
        },
        "filterType": {
          "type": "string",
          "description": "How to join clauses together.",
          "enum": [
            "AND",
            "OR"
          ]
        }
      }
    },
    "generateDownloadURI": {
      "type": "boolean",
      "description": "Whether to do backup export as part of Bulk Operation or not. Default: true."
    }
  },
  "required": [
    "PCID",
    "contactListId"
  ]
}

genesys-outbound_post_contactlist_contacts_search

Query contacts from a contact list. Parameters:

Parameter	Type	Required	Default	Description
`contactListId`	string	Yes	—	Contact List ID
`contactListFilterId`	string	No	—	Contact List Filter ID.
`contactSorts`	object[]	No	—	The order in which to sort contacts.
`criteria`	object	No	—	The criteria value
`pageNumber`	integer	Yes	—	Page number.
`pageSize`	integer	Yes	—	Page size. The max that will be returned is 100.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListId": {
      "type": "string",
      "description": "Contact List ID"
    },
    "contactListFilterId": {
      "type": "string",
      "description": "Contact List Filter ID."
    },
    "contactSorts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "fieldName": {
            "type": "string",
            "description": "Field Name"
          },
          "direction": {
            "type": "string",
            "enum": [
              "ASC",
              "DESC"
            ],
            "description": "The direction in which to sort contacts."
          },
          "numeric": {
            "type": "boolean",
            "description": "Whether or not the column contains numeric data."
          }
        }
      },
      "description": "The order in which to sort contacts."
    },
    "criteria": {
      "type": "object",
      "description": "The criteria value",
      "properties": {
        "clauses": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Groups of conditions to filter the contacts by."
        },
        "filterType": {
          "type": "string",
          "description": "How to join clauses together.",
          "enum": [
            "AND",
            "OR"
          ]
        }
      }
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number."
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size. The max that will be returned is 100."
    }
  },
  "required": [
    "PCID",
    "contactListId",
    "pageNumber",
    "pageSize"
  ]
}

genesys-outbound_post_contactlist_export

Initiate the export of a contact list. Parameters:

Parameter	Type	Required	Default	Description
`contactListId`	string	Yes	—	ContactList ID
`contactIds`	string[]	No	—	Contact IDs to be exported.
`contactListFilterId`	string	No	—	Contact List Filter ID.
`criteria`	object	No	—	The criteria value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListId": {
      "type": "string",
      "description": "ContactList ID"
    },
    "contactIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Contact IDs to be exported."
    },
    "contactListFilterId": {
      "type": "string",
      "description": "Contact List Filter ID."
    },
    "criteria": {
      "type": "object",
      "description": "The criteria value",
      "properties": {
        "clauses": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Groups of conditions to filter the contacts by."
        },
        "filterType": {
          "type": "string",
          "description": "How to join clauses together.",
          "enum": [
            "AND",
            "OR"
          ]
        }
      }
    }
  },
  "required": [
    "PCID",
    "contactListId"
  ]
}

genesys-outbound_post_contactlistfilters

Create Contact List Filter Parameters:

Parameter	Type	Required	Default	Description
`clauses`	object[]	No	—	Groups of conditions to filter the contacts by.
`contactList`	object	No	—	Contact List
`contactListTemplate`	object	No	—	Contact List Template
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`filterType`	string	No	—	How to join clauses together.
`id`	string	No	—	The globally unique identifier for the object.
`name`	string	Yes	—	The name of the list.
`selfUri`	string	No	—	The URI for this object
`sourceType`	string	No	—	The source type the filter is based on.
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "clauses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "filterType": {
            "type": "string",
            "enum": [
              "AND",
              "OR"
            ],
            "description": "How to join predicates together."
          },
          "predicates": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "column": {
                  "type": "string",
                  "description": "Contact list column from the ContactListFilter's contactList."
                },
                "columnType": {
                  "type": "string",
                  "description": "The type of data in the contact column."
                },
                "operator": {
                  "type": "string",
                  "description": "The operator for this ContactListFilterPredicate."
                },
                "value": {
                  "type": "string",
                  "description": "Value with which to compare the contact's data. This could be text, a number, or a relative time. A value for relative time should follow the format PxxDTyyHzzM, where xx, yy, and zz specify the days, hours and minutes. For example, a value of P01DT08H30M corresponds to 1 day, 8 hours, and 30 minutes from now. To specify a time in the past, include a negative sign before each numeric value. For example, a value of P-01DT-08H-30M corresponds to 1 day, 8 hours, and 30 minutes in the past. You can also do things like P01DT00H-30M, which would correspond to 23 hours and 30 minutes from now (1 day - 30 minutes)."
                },
                "range": {
                  "type": "object"
                },
                "inverted": {
                  "type": "boolean",
                  "description": "Inverts the result of the predicate (i.e., if the predicate returns true, inverting it will return false)."
                }
              }
            },
            "description": "Conditions to filter the contacts by."
          }
        }
      },
      "description": "Groups of conditions to filter the contacts by."
    },
    "contactList": {
      "type": "object",
      "description": "Contact List",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "contactListTemplate": {
      "type": "object",
      "description": "Contact List Template",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "filterType": {
      "type": "string",
      "description": "How to join clauses together.",
      "enum": [
        "AND",
        "OR"
      ]
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "name": {
      "type": "string",
      "description": "The name of the list."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "sourceType": {
      "type": "string",
      "description": "The source type the filter is based on.",
      "enum": [
        "ContactList",
        "ContactListTemplate"
      ]
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "name"
  ]
}

genesys-outbound_post_contactlistfilters_bulk_retrieve

Retrieve multiple contact list filters Parameters:

Parameter	Type	Required	Default	Description
`ids`	string[]	Yes	—	The IDs of the Contact List Filters to retrieve.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The IDs of the Contact List Filters to retrieve."
    }
  },
  "required": [
    "PCID",
    "ids"
  ]
}

genesys-outbound_post_contactlistfilters_preview

Get a preview of the output of a contact list filter Parameters:

Parameter	Type	Required	Default	Description
`clauses`	object[]	No	—	Groups of conditions to filter the contacts by.
`contactList`	object	No	—	Contact List
`contactListTemplate`	object	No	—	Contact List Template
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`filterType`	string	No	—	How to join clauses together.
`id`	string	No	—	The globally unique identifier for the object.
`name`	string	Yes	—	The name of the list.
`selfUri`	string	No	—	The URI for this object
`sourceType`	string	No	—	The source type the filter is based on.
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "clauses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "filterType": {
            "type": "string",
            "enum": [
              "AND",
              "OR"
            ],
            "description": "How to join predicates together."
          },
          "predicates": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "column": {
                  "type": "string",
                  "description": "Contact list column from the ContactListFilter's contactList."
                },
                "columnType": {
                  "type": "string",
                  "description": "The type of data in the contact column."
                },
                "operator": {
                  "type": "string",
                  "description": "The operator for this ContactListFilterPredicate."
                },
                "value": {
                  "type": "string",
                  "description": "Value with which to compare the contact's data. This could be text, a number, or a relative time. A value for relative time should follow the format PxxDTyyHzzM, where xx, yy, and zz specify the days, hours and minutes. For example, a value of P01DT08H30M corresponds to 1 day, 8 hours, and 30 minutes from now. To specify a time in the past, include a negative sign before each numeric value. For example, a value of P-01DT-08H-30M corresponds to 1 day, 8 hours, and 30 minutes in the past. You can also do things like P01DT00H-30M, which would correspond to 23 hours and 30 minutes from now (1 day - 30 minutes)."
                },
                "range": {
                  "type": "object"
                },
                "inverted": {
                  "type": "boolean",
                  "description": "Inverts the result of the predicate (i.e., if the predicate returns true, inverting it will return false)."
                }
              }
            },
            "description": "Conditions to filter the contacts by."
          }
        }
      },
      "description": "Groups of conditions to filter the contacts by."
    },
    "contactList": {
      "type": "object",
      "description": "Contact List",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "contactListTemplate": {
      "type": "object",
      "description": "Contact List Template",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "filterType": {
      "type": "string",
      "description": "How to join clauses together.",
      "enum": [
        "AND",
        "OR"
      ]
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "name": {
      "type": "string",
      "description": "The name of the list."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "sourceType": {
      "type": "string",
      "description": "The source type the filter is based on.",
      "enum": [
        "ContactList",
        "ContactListTemplate"
      ]
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "name"
  ]
}

genesys-outbound_post_contactlists

Create a contact List. Parameters:

Parameter	Type	Required	Default	Description
`attemptLimits`	object	No	—	Attempt Limits
`automaticTimeZoneMapping`	boolean	No	—	Indicates if automatic time zone mapping is to be used for this ContactList.
`columnDataTypeSpecifications`	object[]	No	—	The settings of the columns selected for dynamic queueing
`columnNames`	string[]	Yes	—	The names of the contact data columns.
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`division`	object	No	—	The division value
`emailColumns`	object[]	No	—	Indicates which columns are email addresses
`id`	string	No	—	The globally unique identifier for the object.
`importStatus`	object	No	—	Import Status
`name`	string	No	—	The name value
`phoneColumns`	object[]	No	—	Indicates which columns are phone numbers.
`previewModeAcceptedValues`	string[]	No	—	The values in the previewModeColumnName column that indicate a contact should always be dialed in preview mode.
`previewModeColumnName`	string	No	—	A column to check if a contact should always be dialed in preview mode.
`selfUri`	string	No	—	The URI for this object
`size`	integer	No	—	The number of contacts in the ContactList.
`trimWhitespace`	boolean	No	—	Whether to trim white space when importing a contactlist csv file, default value = true
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update
`whatsAppColumns`	object[]	No	—	Indicates which columns are whatsApp contacts
`zipCodeColumnName`	string	No	—	The name of contact list column containing the zip code for use with automatic time zone mapping. Only allowed if ‘automaticTimeZoneMapping’ is set to true.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "attemptLimits": {
      "type": "object",
      "description": "Attempt Limits",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "automaticTimeZoneMapping": {
      "type": "boolean",
      "description": "Indicates if automatic time zone mapping is to be used for this ContactList."
    },
    "columnDataTypeSpecifications": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "columnName": {
            "type": "string",
            "description": "The column name of a column selected for dynamic queueing"
          },
          "columnDataType": {
            "type": "string",
            "enum": [
              "NUMERIC",
              "TEXT",
              "TIMESTAMP"
            ],
            "description": "The data type of the column selected for dynamic queueing (TEXT, NUMERIC or TIMESTAMP)"
          },
          "min": {
            "type": "integer",
            "format": "int32",
            "description": "The minimum length of the numeric column selected for dynamic queueing"
          },
          "max": {
            "type": "integer",
            "format": "int32",
            "description": "The maximum length of the numeric column selected for dynamic queueing"
          },
          "maxLength": {
            "type": "integer",
            "format": "int32",
            "description": "The maximum length of the text column selected for dynamic queueing"
          }
        }
      },
      "description": "The settings of the columns selected for dynamic queueing"
    },
    "columnNames": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The names of the contact data columns."
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "division": {
      "type": "object",
      "description": "The division value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "emailColumns": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "columnName": {
            "type": "string",
            "description": "The name of the email column."
          },
          "type": {
            "type": "string",
            "description": "Indicates the type of the email column. For example, 'work' or 'personal'."
          },
          "contactableTimeColumnName": {
            "type": "string",
            "description": "A name of the contactableTimeColumn"
          },
          "contactableTimeColumn": {
            "type": "string",
            "description": "A column that indicates the timezone to use for a given contact when checking contactable times."
          }
        },
        "required": [
          "columnName",
          "type"
        ]
      },
      "description": "Indicates which columns are email addresses"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "importStatus": {
      "type": "object",
      "description": "Import Status",
      "properties": {
        "state": {
          "type": "string",
          "description": "current status of the import",
          "enum": [
            "IN_PROGRESS",
            "FAILED"
          ]
        },
        "totalRecords": {
          "type": "integer",
          "description": "total number of records to be imported"
        },
        "completedRecords": {
          "type": "integer",
          "description": "number of records finished importing"
        },
        "percentComplete": {
          "type": "integer",
          "description": "percentage of records finished importing"
        },
        "failureReason": {
          "type": "string",
          "description": "if the import has failed, the reason for the failure"
        },
        "targetContactListIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The contact list Ids for target contact lists."
        },
        "listNamePrefix": {
          "type": "string",
          "description": "The prefix for the contact list name"
        }
      },
      "required": [
        "completedRecords",
        "percentComplete",
        "state",
        "totalRecords"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "phoneColumns": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "columnName": {
            "type": "string",
            "description": "The name of the phone column."
          },
          "type": {
            "type": "string",
            "description": "Indicates the type of the phone column. For example, 'cell' or 'home'."
          },
          "callableTimeColumnName": {
            "type": "string",
            "description": "A name of the callableTimeColumn"
          },
          "callableTimeColumn": {
            "type": "string",
            "description": "A column that indicates the timezone to use for a given contact when checking callable times. Not allowed if 'automaticTimeZoneMapping' is set to true."
          }
        },
        "required": [
          "columnName",
          "type"
        ]
      },
      "description": "Indicates which columns are phone numbers."
    },
    "previewModeAcceptedValues": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The values in the previewModeColumnName column that indicate a contact should always be dialed in preview mode."
    },
    "previewModeColumnName": {
      "type": "string",
      "description": "A column to check if a contact should always be dialed in preview mode."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "size": {
      "type": "integer",
      "description": "The number of contacts in the ContactList."
    },
    "trimWhitespace": {
      "type": "boolean",
      "description": "Whether to trim white space when importing a contactlist csv file, default value = true"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    },
    "whatsAppColumns": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "columnName": {
            "type": "string",
            "description": "The name of the whatsApp column."
          },
          "type": {
            "type": "string",
            "description": "Indicates the type of the whatsApp column. For example, 'work' or 'personal'."
          },
          "contactableTimeColumnName": {
            "type": "string",
            "description": "A name of the contactableTimeColumn"
          },
          "contactableTimeColumn": {
            "type": "string",
            "description": "A column that indicates the timezone to use for a given contact when checking contactable times."
          }
        },
        "required": [
          "columnName",
          "type"
        ]
      },
      "description": "Indicates which columns are whatsApp contacts"
    },
    "zipCodeColumnName": {
      "type": "string",
      "description": "The name of contact list column containing the zip code for use with automatic time zone mapping. Only allowed if 'automaticTimeZoneMapping' is set to true."
    }
  },
  "required": [
    "PCID",
    "columnNames"
  ]
}

genesys-outbound_post_contactlists_uploads

Generate presigned upload URL for contact list. Parameters:

Parameter	Type	Required	Default	Description
`clearSystemData`	boolean	No	—	Whether to clear system data
`contactIdName`	string	No	—	The column name from your file to use as the contact id.
`contentType`	string	Yes	—	The content type of the file to upload. Allows MIME types are text/csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
`divisionIdForTargetContactLists`	string	No	—	Id of the division to be used for the creation of the target contact lists. If not provided, Home division will be used.
`fileSpecificationTemplateId`	string	No	—	File specification template ID
`id`	string	No	—	Id of your contact list to upload to
`importTemplateId`	string	No	—	Id of your import template to use.
`listNamePrefix`	string	No	—	String that will replace %N in the listNameFormat specified on the import template.
`signedUrlTimeoutSeconds`	integer	No	—	The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "clearSystemData": {
      "type": "boolean",
      "description": "Whether to clear system data"
    },
    "contactIdName": {
      "type": "string",
      "description": "The column name from your file to use as the contact id."
    },
    "contentType": {
      "type": "string",
      "description": "The content type of the file to upload. Allows MIME types are text/csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
    },
    "divisionIdForTargetContactLists": {
      "type": "string",
      "description": "Id of the division to be used for the creation of the target contact lists. If not provided, Home division will be used."
    },
    "fileSpecificationTemplateId": {
      "type": "string",
      "description": "File specification template ID"
    },
    "id": {
      "type": "string",
      "description": "Id of your contact list to upload to"
    },
    "importTemplateId": {
      "type": "string",
      "description": "Id of your import template to use."
    },
    "listNamePrefix": {
      "type": "string",
      "description": "String that will replace %N in the listNameFormat specified on the import template."
    },
    "signedUrlTimeoutSeconds": {
      "type": "integer",
      "description": "The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds"
    }
  },
  "required": [
    "PCID",
    "contentType"
  ]
}

genesys-outbound_post_contactlisttemplates

Create Contact List Template Parameters:

Parameter	Type	Required	Default	Description
`attemptLimits`	object	No	—	Attempt Limits
`automaticTimeZoneMapping`	boolean	No	—	Indicates if automatic time zone mapping is to be used for this ContactListTemplate.
`columnDataTypeSpecifications`	object[]	No	—	The settings of the columns selected for dynamic queueing
`columnNames`	string[]	Yes	—	The names of the contact data columns.
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`emailColumns`	object[]	No	—	Indicates which columns are email addresses
`id`	string	No	—	The globally unique identifier for the object.
`name`	string	No	—	The name value
`phoneColumns`	object[]	No	—	Indicates which columns are phone numbers.
`previewModeAcceptedValues`	string[]	No	—	The values in the previewModeColumnName column that indicate a contact should always be dialed in preview mode.
`previewModeColumnName`	string	No	—	A column to check if a contact should always be dialed in preview mode.
`selfUri`	string	No	—	The URI for this object
`trimWhitespace`	boolean	No	—	Whether to trim white space when importing a ContactListTemplate csv file, default value = true
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update
`whatsAppColumns`	object[]	No	—	Indicates which columns are whatsApp contacts
`zipCodeColumnName`	string	No	—	The name of ContactListTemplate column containing the zip code for use with automatic time zone mapping. Only allowed if ‘automaticTimeZoneMapping’ is set to true.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "attemptLimits": {
      "type": "object",
      "description": "Attempt Limits",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "automaticTimeZoneMapping": {
      "type": "boolean",
      "description": "Indicates if automatic time zone mapping is to be used for this ContactListTemplate."
    },
    "columnDataTypeSpecifications": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "columnName": {
            "type": "string",
            "description": "The column name of a column selected for dynamic queueing"
          },
          "columnDataType": {
            "type": "string",
            "enum": [
              "NUMERIC",
              "TEXT",
              "TIMESTAMP"
            ],
            "description": "The data type of the column selected for dynamic queueing (TEXT, NUMERIC or TIMESTAMP)"
          },
          "min": {
            "type": "integer",
            "format": "int32",
            "description": "The minimum length of the numeric column selected for dynamic queueing"
          },
          "max": {
            "type": "integer",
            "format": "int32",
            "description": "The maximum length of the numeric column selected for dynamic queueing"
          },
          "maxLength": {
            "type": "integer",
            "format": "int32",
            "description": "The maximum length of the text column selected for dynamic queueing"
          }
        }
      },
      "description": "The settings of the columns selected for dynamic queueing"
    },
    "columnNames": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The names of the contact data columns."
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "emailColumns": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "columnName": {
            "type": "string",
            "description": "The name of the email column."
          },
          "type": {
            "type": "string",
            "description": "Indicates the type of the email column. For example, 'work' or 'personal'."
          },
          "contactableTimeColumnName": {
            "type": "string",
            "description": "A name of the contactableTimeColumn"
          },
          "contactableTimeColumn": {
            "type": "string",
            "description": "A column that indicates the timezone to use for a given contact when checking contactable times."
          }
        },
        "required": [
          "columnName",
          "type"
        ]
      },
      "description": "Indicates which columns are email addresses"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "phoneColumns": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "columnName": {
            "type": "string",
            "description": "The name of the phone column."
          },
          "type": {
            "type": "string",
            "description": "Indicates the type of the phone column. For example, 'cell' or 'home'."
          },
          "callableTimeColumnName": {
            "type": "string",
            "description": "A name of the callableTimeColumn"
          },
          "callableTimeColumn": {
            "type": "string",
            "description": "A column that indicates the timezone to use for a given contact when checking callable times. Not allowed if 'automaticTimeZoneMapping' is set to true."
          }
        },
        "required": [
          "columnName",
          "type"
        ]
      },
      "description": "Indicates which columns are phone numbers."
    },
    "previewModeAcceptedValues": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The values in the previewModeColumnName column that indicate a contact should always be dialed in preview mode."
    },
    "previewModeColumnName": {
      "type": "string",
      "description": "A column to check if a contact should always be dialed in preview mode."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "trimWhitespace": {
      "type": "boolean",
      "description": "Whether to trim white space when importing a ContactListTemplate csv file, default value = true"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    },
    "whatsAppColumns": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "columnName": {
            "type": "string",
            "description": "The name of the whatsApp column."
          },
          "type": {
            "type": "string",
            "description": "Indicates the type of the whatsApp column. For example, 'work' or 'personal'."
          },
          "contactableTimeColumnName": {
            "type": "string",
            "description": "A name of the contactableTimeColumn"
          },
          "contactableTimeColumn": {
            "type": "string",
            "description": "A column that indicates the timezone to use for a given contact when checking contactable times."
          }
        },
        "required": [
          "columnName",
          "type"
        ]
      },
      "description": "Indicates which columns are whatsApp contacts"
    },
    "zipCodeColumnName": {
      "type": "string",
      "description": "The name of ContactListTemplate column containing the zip code for use with automatic time zone mapping. Only allowed if 'automaticTimeZoneMapping' is set to true."
    }
  },
  "required": [
    "PCID",
    "columnNames"
  ]
}

genesys-outbound_post_contactlisttemplates_bulk_add

Add multiple contact list templates Parameters:

Parameter	Type	Required	Default	Description
`body`	object[]	Yes	—	contact list template(s) to add

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "body": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The globally unique identifier for the object."
          },
          "name": {
            "type": "string",
            "description": "The name value"
          },
          "dateCreated": {
            "type": "string",
            "format": "date-time",
            "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
          },
          "dateModified": {
            "type": "string",
            "format": "date-time",
            "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
          },
          "version": {
            "type": "integer",
            "format": "int32",
            "description": "Required for updates, must match the version number of the most recent update"
          },
          "columnNames": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The names of the contact data columns."
          },
          "phoneColumns": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "columnName": {
                  "type": "string",
                  "description": "The name of the phone column."
                },
                "type": {
                  "type": "string",
                  "description": "Indicates the type of the phone column. For example, 'cell' or 'home'."
                },
                "callableTimeColumnName": {
                  "type": "string",
                  "description": "A name of the callableTimeColumn"
                },
                "callableTimeColumn": {
                  "type": "string",
                  "description": "A column that indicates the timezone to use for a given contact when checking callable times. Not allowed if 'automaticTimeZoneMapping' is set to true."
                }
              }
            },
            "description": "Indicates which columns are phone numbers."
          },
          "emailColumns": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "columnName": {
                  "type": "string",
                  "description": "The name of the email column."
                },
                "type": {
                  "type": "string",
                  "description": "Indicates the type of the email column. For example, 'work' or 'personal'."
                },
                "contactableTimeColumnName": {
                  "type": "string",
                  "description": "A name of the contactableTimeColumn"
                },
                "contactableTimeColumn": {
                  "type": "string",
                  "description": "A column that indicates the timezone to use for a given contact when checking contactable times."
                }
              }
            },
            "description": "Indicates which columns are email addresses"
          },
          "whatsAppColumns": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "columnName": {
                  "type": "string",
                  "description": "The name of the whatsApp column."
                },
                "type": {
                  "type": "string",
                  "description": "Indicates the type of the whatsApp column. For example, 'work' or 'personal'."
                },
                "contactableTimeColumnName": {
                  "type": "string",
                  "description": "A name of the contactableTimeColumn"
                },
                "contactableTimeColumn": {
                  "type": "string",
                  "description": "A column that indicates the timezone to use for a given contact when checking contactable times."
                }
              }
            },
            "description": "Indicates which columns are whatsApp contacts"
          },
          "previewModeColumnName": {
            "type": "string",
            "description": "A column to check if a contact should always be dialed in preview mode."
          },
          "previewModeAcceptedValues": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The values in the previewModeColumnName column that indicate a contact should always be dialed in preview mode."
          },
          "attemptLimits": {
            "type": "object",
            "description": "Attempt Limits"
          },
          "automaticTimeZoneMapping": {
            "type": "boolean",
            "description": "Indicates if automatic time zone mapping is to be used for this ContactListTemplate."
          },
          "zipCodeColumnName": {
            "type": "string",
            "description": "The name of ContactListTemplate column containing the zip code for use with automatic time zone mapping. Only allowed if 'automaticTimeZoneMapping' is set to true."
          },
          "columnDataTypeSpecifications": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "columnName": {
                  "type": "string",
                  "description": "The column name of a column selected for dynamic queueing"
                },
                "columnDataType": {
                  "type": "string",
                  "description": "The data type of the column selected for dynamic queueing (TEXT, NUMERIC or TIMESTAMP)"
                },
                "min": {
                  "type": "integer",
                  "description": "The minimum length of the numeric column selected for dynamic queueing"
                },
                "max": {
                  "type": "integer",
                  "description": "The maximum length of the numeric column selected for dynamic queueing"
                },
                "maxLength": {
                  "type": "integer",
                  "description": "The maximum length of the text column selected for dynamic queueing"
                }
              }
            },
            "description": "The settings of the columns selected for dynamic queueing"
          },
          "trimWhitespace": {
            "type": "boolean",
            "description": "Whether to trim white space when importing a ContactListTemplate csv file, default value = true"
          },
          "selfUri": {
            "type": "string",
            "format": "uri",
            "description": "The URI for this object"
          }
        },
        "required": [
          "columnNames"
        ]
      },
      "description": "contact list template(s) to add"
    }
  },
  "required": [
    "PCID",
    "body"
  ]
}

genesys-outbound_post_contactlisttemplates_bulk_retrieve

Get multiple contact list templates Parameters:

Parameter	Type	Required	Default	Description
`ids`	string[]	Yes	—	The IDs of the Contact List Templates to retrieve.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The IDs of the Contact List Templates to retrieve."
    }
  },
  "required": [
    "PCID",
    "ids"
  ]
}

genesys-outbound_post_conversation_dnc

Add phone numbers to a Dialer DNC list. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation ID"
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

genesys-outbound_post_digitalrulesets

Create an Outbound Digital Rule Set Parameters:

Parameter	Type	Required	Default	Description
`contactList`	object	No	—	Contact List
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`id`	string	No	—	The globally unique identifier for the object.
`name`	string	No	—	The name value
`rules`	object[]	Yes	—	The list of rules.
`selfUri`	string	No	—	The URI for this object
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactList": {
      "type": "object",
      "description": "Contact List",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "rules": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The identifier of the rule."
          },
          "name": {
            "type": "string",
            "description": "The name of the rule."
          },
          "order": {
            "type": "integer",
            "format": "int32",
            "description": "The ranked order of the rule. Rules are processed from lowest number to highest."
          },
          "category": {
            "type": "string",
            "enum": [
              "PreContact",
              "PostContact"
            ],
            "description": "The category of the rule."
          },
          "conditions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "inverted": {
                  "type": "boolean",
                  "description": "If true, inverts the result of evaluating this condition. Default is false."
                },
                "contactColumnConditionSettings": {
                  "type": "object"
                },
                "contactAddressConditionSettings": {
                  "type": "object"
                },
                "contactAddressTypeConditionSettings": {
                  "type": "object"
                },
                "lastAttemptByColumnConditionSettings": {
                  "type": "object"
                },
                "lastAttemptOverallConditionSettings": {
                  "type": "object"
                },
                "lastResultByColumnConditionSettings": {
                  "type": "object"
                },
                "lastResultOverallConditionSettings": {
                  "type": "object"
                },
                "dataActionConditionSettings": {
                  "type": "object"
                }
              }
            },
            "description": "A list of conditions to evaluate. All of the Conditions must evaluate to true to trigger the actions."
          },
          "actions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "updateContactColumnActionSettings": {
                  "type": "object"
                },
                "doNotSendActionSettings": {
                  "type": "object"
                },
                "appendToDncActionSettings": {
                  "type": "object"
                },
                "markContactUncontactableActionSettings": {
                  "type": "object"
                },
                "markContactAddressUncontactableActionSettings": {
                  "type": "object"
                },
                "setContentTemplateActionSettings": {
                  "type": "object"
                },
                "setSmsPhoneNumberActionSettings": {
                  "type": "object"
                },
                "setWhatsAppIntegrationActionSettings": {
                  "type": "object"
                }
              }
            },
            "description": "The list of actions to be taken if all conditions are true."
          }
        },
        "required": [
          "actions",
          "category",
          "conditions",
          "name",
          "order"
        ]
      },
      "description": "The list of rules."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "rules"
  ]
}

genesys-outbound_post_dnclist_emailaddresses

Add email addresses to a DNC list. Parameters:

Parameter	Type	Required	Default	Description
`dncListId`	string	Yes	—	DncList ID
`body`	string[]	Yes	—	DNC email addresses

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dncListId": {
      "type": "string",
      "description": "DncList ID"
    },
    "body": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "DNC email addresses"
    }
  },
  "required": [
    "PCID",
    "dncListId",
    "body"
  ]
}

genesys-outbound_post_dnclist_export

Initiate the export of a dnc list. Parameters:

Parameter	Type	Required	Default	Description
`dncListId`	string	Yes	—	DncList ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dncListId": {
      "type": "string",
      "description": "DncList ID"
    }
  },
  "required": [
    "PCID",
    "dncListId"
  ]
}

genesys-outbound_post_dnclist_phonenumbers

Add phone numbers to a DNC list. Parameters:

Parameter	Type	Required	Default	Description
`dncListId`	string	Yes	—	DncList ID
`expirationDateTime`	string	No	—	Expiration date for DNC phone numbers in yyyy-MM-ddTHH:mmZ format
`body`	string[]	Yes	—	DNC Phone Numbers

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dncListId": {
      "type": "string",
      "description": "DncList ID"
    },
    "expirationDateTime": {
      "type": "string",
      "description": "Expiration date for DNC phone numbers in yyyy-MM-ddTHH:mmZ format"
    },
    "body": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "DNC Phone Numbers"
    }
  },
  "required": [
    "PCID",
    "dncListId",
    "body"
  ]
}

genesys-outbound_post_dnclists

Create dialer DNC list Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	string	No	—	A dnc.com campaignId. Optional if the dncSourceType is dnc.com.
`contactMethod`	string	No	—	The contact method. Required if dncSourceType is rds.
`customExclusionColumn`	string	No	—	The column to evaluate exclusion against. Required if the dncSourceType is rds_custom.
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`division`	object	No	—	The division value
`dncCodes`	string[]	No	—	The list of dnc.com codes to be treated as DNC. Required if the dncSourceType is dnc.com.
`dncSourceType`	string	Yes	—	The type of the DncList.
`id`	string	No	—	The globally unique identifier for the object.
`importStatus`	object	No	—	Import Status
`licenseId`	string	No	—	A gryphon license number. Required if the dncSourceType is gryphon.
`loginId`	string	No	—	A dnc.com loginId. Required if the dncSourceType is dnc.com.
`name`	string	Yes	—	The name of the DncList.
`selfUri`	string	No	—	The URI for this object
`size`	integer	No	—	The total number of phone numbers in the DncList.
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "string",
      "description": "A dnc.com campaignId. Optional if the dncSourceType is dnc.com."
    },
    "contactMethod": {
      "type": "string",
      "description": "The contact method. Required if dncSourceType is rds.",
      "enum": [
        "Email",
        "Phone",
        "Any",
        "WhatsApp"
      ]
    },
    "customExclusionColumn": {
      "type": "string",
      "description": "The column to evaluate exclusion against. Required if the dncSourceType is rds_custom."
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "division": {
      "type": "object",
      "description": "The division value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "dncCodes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of dnc.com codes to be treated as DNC. Required if the dncSourceType is dnc.com."
    },
    "dncSourceType": {
      "type": "string",
      "description": "The type of the DncList.",
      "enum": [
        "rds",
        "rds_custom",
        "dnc.com",
        "gryphon"
      ]
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "importStatus": {
      "type": "object",
      "description": "Import Status",
      "properties": {
        "state": {
          "type": "string",
          "description": "current status of the import",
          "enum": [
            "IN_PROGRESS",
            "FAILED"
          ]
        },
        "totalRecords": {
          "type": "integer",
          "description": "total number of records to be imported"
        },
        "completedRecords": {
          "type": "integer",
          "description": "number of records finished importing"
        },
        "percentComplete": {
          "type": "integer",
          "description": "percentage of records finished importing"
        },
        "failureReason": {
          "type": "string",
          "description": "if the import has failed, the reason for the failure"
        },
        "targetContactListIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The contact list Ids for target contact lists."
        },
        "listNamePrefix": {
          "type": "string",
          "description": "The prefix for the contact list name"
        }
      },
      "required": [
        "completedRecords",
        "percentComplete",
        "state",
        "totalRecords"
      ]
    },
    "licenseId": {
      "type": "string",
      "description": "A gryphon license number. Required if the dncSourceType is gryphon."
    },
    "loginId": {
      "type": "string",
      "description": "A dnc.com loginId. Required if the dncSourceType is dnc.com."
    },
    "name": {
      "type": "string",
      "description": "The name of the DncList."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "size": {
      "type": "integer",
      "description": "The total number of phone numbers in the DncList."
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "dncSourceType",
    "name"
  ]
}

genesys-outbound_post_dnclists_uploads

Generate presigned upload URL for dnc list. Parameters:

Parameter	Type	Required	Default	Description
`contentType`	string	Yes	—	The content type of the file to upload. Allows all types are text/csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
`customExclusionColumns`	string	No	—	The column names from your file from which to upload dnc custom exclusion column entries.
`emailColumns`	string	No	—	The column names from your file from which to upload dnc emails.
`expirationDateTimeColumn`	string	No	—	The column name from your file to use as the dnc expiration date time.
`id`	string	Yes	—	Id of your dnc list to upload to
`phoneColumns`	string	No	—	The column names from your file from which to upload dnc phone numbers.
`signedUrlTimeoutSeconds`	integer	No	—	The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds
`whatsAppColumns`	string	No	—	The column names from your file from which to upload dnc whatsapp.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contentType": {
      "type": "string",
      "description": "The content type of the file to upload. Allows all types are text/csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
    },
    "customExclusionColumns": {
      "type": "string",
      "description": "The column names from your file from which to upload dnc custom exclusion column entries."
    },
    "emailColumns": {
      "type": "string",
      "description": "The column names from your file from which to upload dnc emails."
    },
    "expirationDateTimeColumn": {
      "type": "string",
      "description": "The column name from your file to use as the dnc expiration date time."
    },
    "id": {
      "type": "string",
      "description": "Id of your dnc list to upload to"
    },
    "phoneColumns": {
      "type": "string",
      "description": "The column names from your file from which to upload dnc phone numbers."
    },
    "signedUrlTimeoutSeconds": {
      "type": "integer",
      "description": "The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds"
    },
    "whatsAppColumns": {
      "type": "string",
      "description": "The column names from your file from which to upload dnc whatsapp."
    }
  },
  "required": [
    "PCID",
    "contentType",
    "id"
  ]
}

genesys-outbound_post_filespecificationtemplates

Create File Specification Template Parameters:

Parameter	Type	Required	Default	Description
`columnInformation`	object[]	No	—	Columns specification
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`delimiter`	string	No	—	Kind of delimiter
`delimiterValue`	string	No	—	Delimiter character, used only when delimiter=“Custom”
`description`	string	No	—	Description of the file specification template
`format`	string	Yes	—	File format
`header`	boolean	No	—	If true indicates that delimited file has a header row, which can provide column names
`id`	string	No	—	The globally unique identifier for the object.
`name`	string	Yes	—	The name of the File Specification template.
`numberOfHeadingLinesSkipped`	integer	No	—	Number of heading lines to be skipped
`numberOfTrailingLinesSkipped`	integer	No	—	Number of trailing lines to be skipped
`preprocessingRules`	object[]	No	—	Preprocessing rules
`selfUri`	string	No	—	The URI for this object
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "columnInformation": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "columnName": {
            "type": "string",
            "description": "Column name. Mandatory for Fixed position/length file format."
          },
          "columnNumber": {
            "type": "integer",
            "format": "int32",
            "description": "0 based column number in delimited file format"
          },
          "startPosition": {
            "type": "integer",
            "format": "int32",
            "description": "Zero-based position of the first column's character. Mandatory for Fixed position/length file format."
          },
          "length": {
            "type": "integer",
            "format": "int32",
            "description": "Column width. Mandatory for Fixed position/length file format."
          }
        }
      },
      "description": "Columns specification"
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "delimiter": {
      "type": "string",
      "description": "Kind of delimiter",
      "enum": [
        "Comma",
        "Pipe",
        "Colon",
        "Tab",
        "Semicolon",
        "Custom"
      ]
    },
    "delimiterValue": {
      "type": "string",
      "description": "Delimiter character, used only when delimiter=\"Custom\""
    },
    "description": {
      "type": "string",
      "description": "Description of the file specification template"
    },
    "format": {
      "type": "string",
      "description": "File format",
      "enum": [
        "FixedLength",
        "Delimited"
      ]
    },
    "header": {
      "type": "boolean",
      "description": "If true indicates that delimited file has a header row, which can provide column names"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "name": {
      "type": "string",
      "description": "The name of the File Specification template."
    },
    "numberOfHeadingLinesSkipped": {
      "type": "integer",
      "description": "Number of heading lines to be skipped"
    },
    "numberOfTrailingLinesSkipped": {
      "type": "integer",
      "description": "Number of trailing lines to be skipped"
    },
    "preprocessingRules": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "find": {
            "type": "string",
            "description": "The regular expression to which file lines are to be matched."
          },
          "replaceWith": {
            "type": "string",
            "description": "The string to be substituted for each match."
          },
          "global": {
            "type": "boolean",
            "description": "Replaces all matching substrings in every line."
          },
          "ignoreCase": {
            "type": "boolean",
            "description": "Enables case-insensitive matching"
          }
        }
      },
      "description": "Preprocessing rules"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "format",
    "name"
  ]
}

genesys-outbound_post_importtemplates

Create Import Template Parameters:

Parameter	Type	Required	Default	Description
`contactListFilter`	object	No	—	Contact List Filter
`contactListTemplate`	object	Yes	—	Contact List Template
`customListNameFormatValue`	string	No	—	Custom value for the list name format, at least %N is required. Any character other than the specified tokens will be used as is. Available tokens: %N: ListNamePrefix; %P: Part number; %F: Filter name; %C: Column value; YYYY: year; MM: month; DD: day; hh: hour; mm: minute; ss: second.
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`id`	string	No	—	The globally unique identifier for the object.
`importStatus`	object	No	—	Import Status
`listNameFormat`	string	No	—	The list name format for target ContactLists. When Custom is provided, customListNameFormatValue is required.
`name`	string	No	—	The name of the import template.
`selfUri`	string	No	—	The URI for this object
`splittingInformation`	object	No	—	Splitting Information
`useSplittingCriteria`	boolean	No	—	Whether or not to use splitting criteria. Default is false.
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListFilter": {
      "type": "object",
      "description": "Contact List Filter",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "contactListTemplate": {
      "type": "object",
      "description": "Contact List Template",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "customListNameFormatValue": {
      "type": "string",
      "description": "Custom value for the list name format, at least %N is required. Any character other than the specified tokens will be used as is. Available tokens: %N: ListNamePrefix; %P: Part number; %F: Filter name; %C: Column value; YYYY: year; MM: month; DD: day; hh: hour; mm: minute; ss: second."
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "importStatus": {
      "type": "object",
      "description": "Import Status",
      "properties": {
        "state": {
          "type": "string",
          "description": "current status of the import",
          "enum": [
            "IN_PROGRESS",
            "FAILED"
          ]
        },
        "totalRecords": {
          "type": "integer",
          "description": "total number of records to be imported"
        },
        "completedRecords": {
          "type": "integer",
          "description": "number of records finished importing"
        },
        "percentComplete": {
          "type": "integer",
          "description": "percentage of records finished importing"
        },
        "failureReason": {
          "type": "string",
          "description": "if the import has failed, the reason for the failure"
        },
        "targetContactListIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The contact list Ids for target contact lists."
        },
        "listNamePrefix": {
          "type": "string",
          "description": "The prefix for the contact list name"
        }
      },
      "required": [
        "completedRecords",
        "percentComplete",
        "state",
        "totalRecords"
      ]
    },
    "listNameFormat": {
      "type": "string",
      "description": "The list name format for target ContactLists. When Custom is provided, customListNameFormatValue is required.",
      "enum": [
        "ListNamePrefix",
        "ListNamePrefixMonthDayYear",
        "ListNamePrefixMonthDayYearHourMinuteSecond",
        "ListNamePrefixPart",
        "ListNamePrefixMonthDayYearPart",
        "ListNamePrefixMonthDayYearHourMinuteSecondPart",
        "Custom"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name of the import template."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "splittingInformation": {
      "type": "object",
      "description": "Splitting Information",
      "properties": {
        "criteria": {
          "type": "string",
          "description": "The splitting criteria type",
          "enum": [
            "Percentage",
            "Quantity",
            "Column",
            "Custom"
          ]
        },
        "criteriaValue": {
          "type": "string",
          "description": "The criteria value for the specified criteria type"
        },
        "createRemainderContactList": {
          "type": "boolean",
          "description": "Whether to create remainder contact list"
        },
        "useWaterfallRule": {
          "type": "boolean",
          "description": "Whether to use waterfall rule"
        }
      }
    },
    "useSplittingCriteria": {
      "type": "boolean",
      "description": "Whether or not to use splitting criteria. Default is false."
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "contactListTemplate"
  ]
}

genesys-outbound_post_importtemplates_bulk_add

Add multiple import templates Parameters:

Parameter	Type	Required	Default	Description
`body`	object[]	Yes	—	import template(s) to add

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "body": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The globally unique identifier for the object."
          },
          "name": {
            "type": "string",
            "description": "The name of the import template."
          },
          "dateCreated": {
            "type": "string",
            "format": "date-time",
            "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
          },
          "dateModified": {
            "type": "string",
            "format": "date-time",
            "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
          },
          "version": {
            "type": "integer",
            "format": "int32",
            "description": "Required for updates, must match the version number of the most recent update"
          },
          "contactListTemplate": {
            "type": "object",
            "description": "Contact List Template"
          },
          "contactListFilter": {
            "type": "object",
            "description": "Contact List Filter"
          },
          "useSplittingCriteria": {
            "type": "boolean",
            "description": "Whether or not to use splitting criteria. Default is false."
          },
          "splittingInformation": {
            "type": "object",
            "description": "Splitting Information"
          },
          "listNameFormat": {
            "type": "string",
            "enum": [
              "ListNamePrefix",
              "ListNamePrefixMonthDayYear",
              "ListNamePrefixMonthDayYearHourMinuteSecond",
              "ListNamePrefixPart",
              "ListNamePrefixMonthDayYearPart",
              "ListNamePrefixMonthDayYearHourMinuteSecondPart",
              "Custom"
            ],
            "description": "The list name format for target ContactLists. When Custom is provided, customListNameFormatValue is required."
          },
          "customListNameFormatValue": {
            "type": "string",
            "description": "Custom value for the list name format, at least %N is required. Any character other than the specified tokens will be used as is. Available tokens: %N: ListNamePrefix; %P: Part number; %F: Filter name; %C: Column value; YYYY: year; MM: month; DD: day; hh: hour; mm: minute; ss: second."
          },
          "importStatus": {
            "type": "object",
            "description": "Import Status"
          },
          "selfUri": {
            "type": "string",
            "format": "uri",
            "description": "The URI for this object"
          }
        },
        "required": [
          "contactListTemplate"
        ]
      },
      "description": "import template(s) to add"
    }
  },
  "required": [
    "PCID",
    "body"
  ]
}

genesys-outbound_post_messagingcampaign_start

Start the campaign Parameters:

Parameter	Type	Required	Default	Description
`messagingCampaignId`	string	Yes	—	The Messaging Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "messagingCampaignId": {
      "type": "string",
      "description": "The Messaging Campaign ID"
    }
  },
  "required": [
    "PCID",
    "messagingCampaignId"
  ]
}

genesys-outbound_post_messagingcampaign_stop

Stop the campaign Parameters:

Parameter	Type	Required	Default	Description
`messagingCampaignId`	string	Yes	—	The Messaging Campaign ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "messagingCampaignId": {
      "type": "string",
      "description": "The Messaging Campaign ID"
    }
  },
  "required": [
    "PCID",
    "messagingCampaignId"
  ]
}

genesys-outbound_post_messagingcampaigns

Create a Messaging Campaign Parameters:

Parameter	Type	Required	Default	Description
`alwaysRunning`	boolean	No	—	Whether this messaging campaign is always running
`callableTimeSet`	object	No	—	Callable Time Set
`campaignStatus`	string	No	—	The current status of the messaging campaign. A messaging campaign may be turned ‘on’ or ‘off’.
`contactList`	object	Yes	—	Contact List
`contactListFilters`	object[]	No	—	The contact list filter to check before sending a message for this messaging campaign.
`contactSorts`	object[]	No	—	The order in which to sort contacts for dialing, based on up to four columns.
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`division`	object	No	—	The division value
`dncLists`	object[]	No	—	The dnc lists to check before sending a message for this messaging campaign.
`dynamicContactQueueingSettings`	object	No	—	Dynamic Contact Queueing Settings
`emailConfig`	object	No	—	Email Config
`errors`	object[]	No	—	A list of current error conditions associated with this messaging campaign.
`id`	string	No	—	The globally unique identifier for the object.
`messagesPerMinute`	integer	Yes	—	How many messages this messaging campaign will send per minute.
`name`	string	No	—	The name value
`ruleSets`	object[]	No	—	Rule Sets to be applied while this campaign is sending messages
`selfUri`	string	No	—	The URI for this object
`smsConfig`	object	No	—	Sms Config
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update
`whatsAppConfig`	object	No	—	Whats App Config

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alwaysRunning": {
      "type": "boolean",
      "description": "Whether this messaging campaign is always running"
    },
    "callableTimeSet": {
      "type": "object",
      "description": "Callable Time Set",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "campaignStatus": {
      "type": "string",
      "description": "The current status of the messaging campaign. A messaging campaign may be turned 'on' or 'off'.",
      "enum": [
        "on",
        "stopping",
        "off",
        "complete",
        "invalid",
        "forced_off",
        "forced_stopping"
      ]
    },
    "contactList": {
      "type": "object",
      "description": "Contact List",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "contactListFilters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "name": {
            "type": "string",
            "description": "The name value"
          },
          "selfUri": {
            "type": "string",
            "format": "uri",
            "description": "Self Uri"
          }
        }
      },
      "description": "The contact list filter to check before sending a message for this messaging campaign."
    },
    "contactSorts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "fieldName": {
            "type": "string",
            "description": "Field Name"
          },
          "direction": {
            "type": "string",
            "enum": [
              "ASC",
              "DESC"
            ],
            "description": "The direction in which to sort contacts."
          },
          "numeric": {
            "type": "boolean",
            "description": "Whether or not the column contains numeric data."
          }
        }
      },
      "description": "The order in which to sort contacts for dialing, based on up to four columns."
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "division": {
      "type": "object",
      "description": "The division value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "dncLists": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "name": {
            "type": "string",
            "description": "The name value"
          },
          "selfUri": {
            "type": "string",
            "format": "uri",
            "description": "Self Uri"
          }
        }
      },
      "description": "The dnc lists to check before sending a message for this messaging campaign."
    },
    "dynamicContactQueueingSettings": {
      "type": "object",
      "description": "Dynamic Contact Queueing Settings",
      "properties": {
        "sort": {
          "type": "boolean",
          "description": "Whether to sort contacts dynamically"
        },
        "filter": {
          "type": "boolean",
          "description": "Whether to filter contacts dynamically"
        }
      }
    },
    "emailConfig": {
      "type": "object",
      "description": "Email Config",
      "properties": {
        "emailColumns": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The contact list columns specifying the email address(es) of the contact."
        },
        "contentTemplate": {
          "type": "object",
          "description": "Content Template"
        },
        "fromAddress": {
          "type": "object",
          "description": "From Address"
        },
        "replyToAddress": {
          "type": "object",
          "description": "Reply To Address"
        }
      },
      "required": [
        "emailColumns",
        "fromAddress"
      ]
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "description": "name of the error"
          },
          "details": {
            "type": "string",
            "description": "additional information regarding the error"
          },
          "userParams": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            },
            "description": "parameters to be inserted into details."
          }
        },
        "required": [
          "error"
        ]
      },
      "description": "A list of current error conditions associated with this messaging campaign."
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "messagesPerMinute": {
      "type": "integer",
      "description": "How many messages this messaging campaign will send per minute."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "ruleSets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "name": {
            "type": "string",
            "description": "The name value"
          },
          "selfUri": {
            "type": "string",
            "format": "uri",
            "description": "Self Uri"
          }
        }
      },
      "description": "Rule Sets to be applied while this campaign is sending messages"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "smsConfig": {
      "type": "object",
      "description": "Sms Config",
      "properties": {
        "messageColumn": {
          "type": "string",
          "description": "The Contact List column specifying the message to send to the contact."
        },
        "phoneColumn": {
          "type": "string",
          "description": "The Contact List column specifying the phone number to send a message to."
        },
        "senderSmsPhoneNumber": {
          "type": "object",
          "description": "Sender Sms Phone Number"
        },
        "contentTemplate": {
          "type": "object",
          "description": "Content Template"
        }
      },
      "required": [
        "messageColumn",
        "phoneColumn",
        "senderSmsPhoneNumber"
      ]
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    },
    "whatsAppConfig": {
      "type": "object",
      "description": "Whats App Config",
      "properties": {
        "whatsAppColumns": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The contact list columns specifying the WhatsApp address(es) of the contact."
        },
        "whatsAppIntegration": {
          "type": "object",
          "description": "Whats App Integration"
        },
        "contentTemplate": {
          "type": "object",
          "description": "Content Template"
        }
      },
      "required": [
        "contentTemplate",
        "whatsAppColumns",
        "whatsAppIntegration"
      ]
    }
  },
  "required": [
    "PCID",
    "contactList",
    "messagesPerMinute"
  ]
}

genesys-outbound_post_messagingcampaigns_progress

Get progress for a list of messaging campaigns Parameters:

Parameter	Type	Required	Default	Description
`body`	string[]	Yes	—	Messaging Campaign IDs

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "body": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Messaging Campaign IDs"
    }
  },
  "required": [
    "PCID",
    "body"
  ]
}

genesys-outbound_post_rulesets

Create a Rule Set. Parameters:

Parameter	Type	Required	Default	Description
`contactList`	object	No	—	Contact List
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`id`	string	No	—	The globally unique identifier for the object.
`name`	string	Yes	—	The name of the RuleSet.
`queue`	object	No	—	The queue value
`rules`	object[]	Yes	—	The list of rules.
`selfUri`	string	No	—	The URI for this object
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactList": {
      "type": "object",
      "description": "Contact List",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "name": {
      "type": "string",
      "description": "The name of the RuleSet."
    },
    "queue": {
      "type": "object",
      "description": "The queue value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "rules": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The identifier of the rule."
          },
          "name": {
            "type": "string",
            "description": "The name of the rule."
          },
          "order": {
            "type": "integer",
            "format": "int32",
            "description": "The ranked order of the rule. Rules are processed from lowest number to highest."
          },
          "category": {
            "type": "string",
            "enum": [
              "DIALER_PRECALL",
              "DIALER_WRAPUP"
            ],
            "description": "The category of the rule."
          },
          "conditions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "description": "The type of the condition."
                },
                "inverted": {
                  "type": "boolean",
                  "description": "If true, inverts the result of evaluating this Condition. Default is false."
                },
                "attributeName": {
                  "type": "string",
                  "description": "An attribute name associated with this Condition. Required for a contactAttributeCondition."
                },
                "value": {
                  "type": "string",
                  "description": "A value associated with this Condition. This could be text, a number, or a relative time. Not used for a DataActionCondition."
                },
                "valueType": {
                  "type": "string",
                  "description": "The type of the value associated with this Condition. Not used for a DataActionCondition."
                },
                "operator": {
                  "type": "string",
                  "description": "An operation with which to evaluate the Condition. Not used for a DataActionCondition."
                },
                "codes": {
                  "type": "array",
                  "description": "List of wrap-up code identifiers. Required for a wrapupCondition."
                },
                "property": {
                  "type": "string",
                  "description": "A value associated with the property type of this Condition. Required for a contactPropertyCondition."
                },
                "propertyType": {
                  "type": "string",
                  "description": "The type of the property associated with this Condition. Required for a contactPropertyCondition."
                },
                "dataAction": {
                  "type": "object"
                },
                "dataNotFoundResolution": {
                  "type": "boolean",
                  "description": "The result of this condition if the data action returns a result indicating there was no data. Required for a DataActionCondition."
                },
                "contactIdField": {
                  "type": "string",
                  "description": "The input field from the data action that the contactId will be passed to for this condition. Valid for a dataActionCondition."
                },
                "callAnalysisResultField": {
                  "type": "string",
                  "description": "The input field from the data action that the callAnalysisResult will be passed to for this condition. Valid for a wrapup dataActionCondition."
                },
                "agentWrapupField": {
                  "type": "string",
                  "description": "The input field from the data action that the agentWrapup will be passed to for this condition. Valid for a wrapup dataActionCondition."
                },
                "contactColumnToDataActionFieldMappings": {
                  "type": "array",
                  "description": "A list of mappings defining which contact data fields will be passed to which data action input fields for this condition. Valid for a dataActionCondition."
                },
                "predicates": {
                  "type": "array",
                  "description": "A list of predicates defining the comparisons to use for this condition. Required for a dataActionCondition."
                },
                "subConditions": {
                  "type": "array",
                  "description": "A list of sub-conditions to evaluate. Required for a timeAndDateCondition."
                },
                "matchAnyConditions": {
                  "type": "boolean",
                  "description": "If true, only one sub-condition must match for the condition to be true. If false, all sub-conditions must match. Default is false. Required for a timeAndDateCondition."
                },
                "timeZoneId": {
                  "type": "string",
                  "description": "The time zone to use for this condition. Required for a timeAndDateCondition."
                }
              }
            },
            "description": "A list of Conditions. All of the Conditions must evaluate to true to trigger the actions."
          },
          "actions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "description": "The type of this DialerAction."
                },
                "actionTypeName": {
                  "type": "string",
                  "description": "Additional type specification for this DialerAction."
                },
                "updateOption": {
                  "type": "string",
                  "description": "Specifies how a contact attribute should be updated. Required for MODIFY_CONTACT_ATTRIBUTE."
                },
                "properties": {
                  "type": "object",
                  "description": "A map of key-value pairs pertinent to the DialerAction. Different types of DialerActions require different properties. MODIFY_CONTACT_ATTRIBUTE with an updateOption of SET takes a contact column as the key and accepts any value. SCHEDULE_CALLBACK takes a key 'callbackOffset' that specifies how far in the future the callback should be scheduled, in minutes. SET_CALLER_ID takes two keys: 'callerAddress', which should be the caller id phone number, and 'callerName'. For either key, you can also specify a column on the contact to get the value from. To do this, specify 'contact.Column', where 'Column' is the name of the contact column from which to get the value. SET_SKILLS takes a key 'skills' with an array of skill ids wrapped into a string (Example: {'skills': '['skillIdHere']'} )."
                },
                "dataAction": {
                  "type": "object"
                },
                "contactColumnToDataActionFieldMappings": {
                  "type": "array",
                  "description": "A list of mappings defining which contact data fields will be passed to which data action input fields for this condition. Valid for a dataActionBehavior."
                },
                "contactIdField": {
                  "type": "string",
                  "description": "The input field from the data action that the contactId will be passed to for this condition. Valid for a dataActionBehavior."
                },
                "callAnalysisResultField": {
                  "type": "string",
                  "description": "The input field from the data action that the callAnalysisResult will be passed to for this condition. Valid for a wrapup dataActionBehavior."
                },
                "agentWrapupField": {
                  "type": "string",
                  "description": "The input field from the data action that the agentWrapup will be passed to for this condition. Valid for a wrapup dataActionBehavior."
                }
              }
            },
            "description": "The list of actions to be taken if the conditions are true."
          }
        },
        "required": [
          "category",
          "conditions",
          "name"
        ]
      },
      "description": "The list of rules."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "name",
    "rules"
  ]
}

genesys-outbound_post_sequences

Create a new campaign sequence. Parameters:

Parameter	Type	Required	Default	Description
`campaigns`	object[]	Yes	—	The ordered list of Campaigns that this CampaignSequence will run.
`currentCampaign`	integer	Yes	—	A zero-based index indicating which Campaign this CampaignSequence is currently on.
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`id`	string	No	—	The globally unique identifier for the object.
`name`	string	No	—	The name value
`repeat`	boolean	No	—	Indicates if a sequence should repeat from the beginning after the last campaign completes. Default is false.
`selfUri`	string	No	—	The URI for this object
`status`	string	Yes	—	The current status of the CampaignSequence. A CampaignSequence can be turned ‘on’ or ‘off’.
`stopMessage`	string	No	—	A message indicating if and why a CampaignSequence has stopped unexpectedly.
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaigns": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "name": {
            "type": "string",
            "description": "The name value"
          },
          "selfUri": {
            "type": "string",
            "format": "uri",
            "description": "Self Uri"
          }
        }
      },
      "description": "The ordered list of Campaigns that this CampaignSequence will run."
    },
    "currentCampaign": {
      "type": "integer",
      "description": "A zero-based index indicating which Campaign this CampaignSequence is currently on."
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "repeat": {
      "type": "boolean",
      "description": "Indicates if a sequence should repeat from the beginning after the last campaign completes. Default is false."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "status": {
      "type": "string",
      "description": "The current status of the CampaignSequence. A CampaignSequence can be turned 'on' or 'off'.",
      "enum": [
        "on",
        "off",
        "complete"
      ]
    },
    "stopMessage": {
      "type": "string",
      "description": "A message indicating if and why a CampaignSequence has stopped unexpectedly."
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "campaigns",
    "currentCampaign",
    "status"
  ]
}

genesys-outbound_put_attemptlimit

Update attempt limits Parameters:

Parameter	Type	Required	Default	Description
`attemptLimitsId`	string	Yes	—	Attempt limits ID
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`id`	string	No	—	The globally unique identifier for the object.
`maxAttemptsPerContact`	integer	No	—	The maximum number of times a contact can be called within the resetPeriod. Required if maxAttemptsPerNumber is not defined.
`maxAttemptsPerNumber`	integer	No	—	The maximum number of times a phone number can be called within the resetPeriod. Required if maxAttemptsPerContact is not defined.
`name`	string	No	—	The name value
`recallEntries`	object	No	—	Configuration for recall attempts.
`resetPeriod`	string	No	—	After how long the number of attempts will be set back to 0. Defaults to NEVER.
`selfUri`	string	No	—	The URI for this object
`timeZoneId`	string	No	—	If the resetPeriod is TODAY, this specifies the timezone in which TODAY occurs. Required if the resetPeriod is TODAY. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "attemptLimitsId": {
      "type": "string",
      "description": "Attempt limits ID"
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "maxAttemptsPerContact": {
      "type": "integer",
      "description": "The maximum number of times a contact can be called within the resetPeriod. Required if maxAttemptsPerNumber is not defined."
    },
    "maxAttemptsPerNumber": {
      "type": "integer",
      "description": "The maximum number of times a phone number can be called within the resetPeriod. Required if maxAttemptsPerContact is not defined."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "recallEntries": {
      "type": "object",
      "description": "Configuration for recall attempts."
    },
    "resetPeriod": {
      "type": "string",
      "description": "After how long the number of attempts will be set back to 0. Defaults to NEVER.",
      "enum": [
        "NEVER",
        "TODAY",
        "DAYS_2",
        "DAYS_3",
        "DAYS_4",
        "DAYS_5",
        "DAYS_6",
        "DAYS_7",
        "DAYS_8",
        "DAYS_9",
        "DAYS_10",
        "DAYS_11",
        "DAYS_12",
        "DAYS_13",
        "DAYS_14",
        "DAYS_15",
        "DAYS_16",
        "DAYS_17",
        "DAYS_18",
        "DAYS_19",
        "DAYS_20",
        "DAYS_21",
        "DAYS_22",
        "DAYS_23",
        "DAYS_24",
        "DAYS_25",
        "DAYS_26",
        "DAYS_27",
        "DAYS_28",
        "DAYS_29",
        "DAYS_30"
      ]
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "timeZoneId": {
      "type": "string",
      "description": "If the resetPeriod is TODAY, this specifies the timezone in which TODAY occurs. Required if the resetPeriod is TODAY. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "attemptLimitsId"
  ]
}

genesys-outbound_put_callabletimeset

Update callable time set Parameters:

Parameter	Type	Required	Default	Description
`callableTimeSetId`	string	Yes	—	Callable Time Set ID
`callableTimes`	object[]	Yes	—	The list of CallableTimes for which it is acceptable to place outbound calls.
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`id`	string	No	—	The globally unique identifier for the object.
`name`	string	Yes	—	The name of the CallableTimeSet.
`selfUri`	string	No	—	The URI for this object
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "callableTimeSetId": {
      "type": "string",
      "description": "Callable Time Set ID"
    },
    "callableTimes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "timeSlots": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "startTime": {
                  "type": "string",
                  "description": "The start time of the interval as an ISO-8601 string, i.e. HH:mm:ss"
                },
                "stopTime": {
                  "type": "string",
                  "description": "The end time of the interval as an ISO-8601 string, i.e. HH:mm:ss"
                },
                "day": {
                  "type": "integer",
                  "description": "The day of the interval. Valid values: [1-7], representing Monday through Sunday"
                }
              }
            },
            "description": "The time intervals for which it is acceptable to place outbound calls."
          },
          "name": {
            "type": "string",
            "description": "The name for the callable time."
          },
          "timeZoneId": {
            "type": "string",
            "description": "The time zone for the time slots; for example, Africa/Abidjan. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
          }
        },
        "required": [
          "timeSlots",
          "timeZoneId"
        ]
      },
      "description": "The list of CallableTimes for which it is acceptable to place outbound calls."
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "name": {
      "type": "string",
      "description": "The name of the CallableTimeSet."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "callableTimeSetId",
    "callableTimes",
    "name"
  ]
}

genesys-outbound_put_callanalysisresponseset

Update a dialer call analysis response set. Parameters:

Parameter	Type	Required	Default	Description
`callAnalysisSetId`	string	Yes	—	Call Analysis Response Set ID
`amdSpeechDistinguishEnabled`	boolean	No	—	Whether to enable answering machine detection
`beepDetectionEnabled`	boolean	No	—	Whether to enable answering machine beep detection
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`id`	string	No	—	The globally unique identifier for the object.
`liveSpeakerDetectionMode`	string	No	—	Setting level of live speaker detection based on ringbacks
`name`	string	Yes	—	The name of the ResponseSet.
`responses`	object	Yes	—	Map of disposition identifiers to reactions. For example: {“disposition.classification.callable.person”: {“reactionType”: “transfer”}}.
`selfUri`	string	No	—	The URI for this object
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "callAnalysisSetId": {
      "type": "string",
      "description": "Call Analysis Response Set ID"
    },
    "amdSpeechDistinguishEnabled": {
      "type": "boolean",
      "description": "Whether to enable answering machine detection"
    },
    "beepDetectionEnabled": {
      "type": "boolean",
      "description": "Whether to enable answering machine beep detection"
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "liveSpeakerDetectionMode": {
      "type": "string",
      "description": "Setting level of live speaker detection based on ringbacks",
      "enum": [
        "Disabled",
        "Low",
        "Medium",
        "High"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name of the ResponseSet."
    },
    "responses": {
      "type": "object",
      "description": "Map of disposition identifiers to reactions. For example: {\"disposition.classification.callable.person\": {\"reactionType\": \"transfer\"}}."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "callAnalysisSetId",
    "name",
    "responses"
  ]
}

genesys-outbound_put_campaign

Update a campaign. Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	string	Yes	—	Campaign ID
`useMaxCallsPerAgentDecimal`	boolean	No	—	Use maxCallsPerAgent with decimal precision
`abandonRate`	number	No	—	The targeted compliance abandon rate percentage. Required for power and predictive campaigns.
`agentOwnedColumn`	string	No	—	Name of the contact list column containing the id of the agent who owns the record. Only applicable to preview campaigns.
`alwaysRunning`	boolean	No	—	Indicates (when true) that the campaign will remain on after contacts are depleted, allowing additional contacts to be appended/added to the contact list and processed by the still-running campaign. The campaign can still be turned off manually.
`callableTimeSet`	object	No	—	Callable Time Set
`callAnalysisLanguage`	string	No	—	The language the edge will use to analyze the call.
`callAnalysisResponseSet`	object	No	—	Call Analysis Response Set
`callbackAutoAnswer`	boolean	No	—	The option manages the auto-answer callback calls
`callerAddress`	string	Yes	—	The caller id phone number to be displayed on the outbound call.
`callerName`	string	Yes	—	The caller id name to be displayed on the outbound call.
`campaignStatus`	string	No	—	The current status of the Campaign. A Campaign may be turned ‘on’ or ‘off’. Required for updates.
`contactList`	object	Yes	—	Contact List
`contactListFilters`	object[]	No	—	Filter to apply to the contact list before dialing. Currently a campaign can only have one filter applied.
`contactSort`	object	No	—	Contact Sort
`contactSorts`	object[]	No	—	The order in which to sort contacts for dialing, based on up to four columns.
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`diagnosticsSettings`	object	No	—	Diagnostics Settings
`dialingMode`	string	Yes	—	The strategy this Campaign will use for dialing.
`division`	object	No	—	The division value
`dncLists`	object[]	No	—	DncLists for this Campaign to check before placing a call.
`dynamicContactQueueingSettings`	object	No	—	Dynamic Contact Queueing Settings
`dynamicLineBalancingSettings`	object	No	—	Dynamic Line Balancing Settings
`edgeGroup`	object	No	—	Edge Group
`errors`	object[]	No	—	A list of current error conditions associated with the campaign.
`id`	string	No	—	The globally unique identifier for the object.
`maxCallsPerAgent`	integer	No	—	The maximum number of calls that can be placed per agent on this campaign
`maxCallsPerAgentDecimal`	number	No	—	The maximum number of calls that can be placed per agent on this campaign with decimal precision
`name`	string	Yes	—	The name of the Campaign.
`noAnswerTimeout`	integer	No	—	How long to wait before dispositioning a call as ‘no-answer’. Default 30 seconds. Only applicable to non-preview campaigns.
`outboundLineCount`	integer	No	—	The number of outbound lines to be concurrently dialed. Only applicable to non-preview campaigns; only required for agentless.
`phoneColumns`	object[]	Yes	—	The ContactPhoneNumberColumns on the ContactList that this Campaign should dial.
`previewAutoEnd`	boolean	No	—	Option to enable preview auto end
`previewTimeOutSeconds`	integer	No	—	The number of seconds before a call will be automatically placed on a preview. A value of 0 indicates no automatic placement of calls. Only applicable to preview campaigns.
`priority`	integer	No	—	The priority of this campaign relative to other campaigns that are running on the same queue. 5 is the highest priority, 1 the lowest.
`queue`	object	No	—	The queue value
`ruleSets`	object[]	No	—	Rule sets to be applied while this campaign is dialing.
`script`	object	No	—	The script value
`selfUri`	string	No	—	The URI for this object
`site`	object	No	—	The site value
`skillColumns`	string[]	No	—	The skill columns on the ContactList that this Campaign should take into account when dialing
`skipPreviewDisabled`	boolean	No	—	Whether or not agents can skip previews without placing a call. Only applicable for preview campaigns.
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "string",
      "description": "Campaign ID"
    },
    "useMaxCallsPerAgentDecimal": {
      "type": "boolean",
      "description": "Use maxCallsPerAgent with decimal precision",
      "enum": [
        true,
        false
      ]
    },
    "abandonRate": {
      "type": "number",
      "description": "The targeted compliance abandon rate percentage. Required for power and predictive campaigns."
    },
    "agentOwnedColumn": {
      "type": "string",
      "description": "Name of the contact list column containing the id of the agent who owns the record. Only applicable to preview campaigns."
    },
    "alwaysRunning": {
      "type": "boolean",
      "description": "Indicates (when true) that the campaign will remain on after contacts are depleted, allowing additional contacts to be appended/added to the contact list and processed by the still-running campaign. The campaign can still be turned off manually."
    },
    "callableTimeSet": {
      "type": "object",
      "description": "Callable Time Set",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "callAnalysisLanguage": {
      "type": "string",
      "description": "The language the edge will use to analyze the call."
    },
    "callAnalysisResponseSet": {
      "type": "object",
      "description": "Call Analysis Response Set",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "callbackAutoAnswer": {
      "type": "boolean",
      "description": "The option manages the auto-answer callback calls"
    },
    "callerAddress": {
      "type": "string",
      "description": "The caller id phone number to be displayed on the outbound call."
    },
    "callerName": {
      "type": "string",
      "description": "The caller id name to be displayed on the outbound call."
    },
    "campaignStatus": {
      "type": "string",
      "description": "The current status of the Campaign. A Campaign may be turned 'on' or 'off'. Required for updates.",
      "enum": [
        "on",
        "stopping",
        "off",
        "complete",
        "invalid",
        "forced_off",
        "forced_stopping"
      ]
    },
    "contactList": {
      "type": "object",
      "description": "Contact List",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "contactListFilters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "name": {
            "type": "string",
            "description": "The name value"
          },
          "selfUri": {
            "type": "string",
            "format": "uri",
            "description": "Self Uri"
          }
        }
      },
      "description": "Filter to apply to the contact list before dialing. Currently a campaign can only have one filter applied."
    },
    "contactSort": {
      "type": "object",
      "description": "Contact Sort",
      "properties": {
        "fieldName": {
          "type": "string",
          "description": "Field Name"
        },
        "direction": {
          "type": "string",
          "description": "The direction in which to sort contacts.",
          "enum": [
            "ASC",
            "DESC"
          ]
        },
        "numeric": {
          "type": "boolean",
          "description": "Whether or not the column contains numeric data."
        }
      }
    },
    "contactSorts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "fieldName": {
            "type": "string",
            "description": "Field Name"
          },
          "direction": {
            "type": "string",
            "enum": [
              "ASC",
              "DESC"
            ],
            "description": "The direction in which to sort contacts."
          },
          "numeric": {
            "type": "boolean",
            "description": "Whether or not the column contains numeric data."
          }
        }
      },
      "description": "The order in which to sort contacts for dialing, based on up to four columns."
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "diagnosticsSettings": {
      "type": "object",
      "description": "Diagnostics Settings",
      "properties": {
        "reportLowMaxCallsPerAgentAlert": {
          "type": "boolean",
          "description": "Whether to report on low max calls per agent alerts."
        }
      }
    },
    "dialingMode": {
      "type": "string",
      "description": "The strategy this Campaign will use for dialing.",
      "enum": [
        "agentless",
        "preview",
        "power",
        "predictive",
        "progressive",
        "external"
      ]
    },
    "division": {
      "type": "object",
      "description": "The division value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "dncLists": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "name": {
            "type": "string",
            "description": "The name value"
          },
          "selfUri": {
            "type": "string",
            "format": "uri",
            "description": "Self Uri"
          }
        }
      },
      "description": "DncLists for this Campaign to check before placing a call."
    },
    "dynamicContactQueueingSettings": {
      "type": "object",
      "description": "Dynamic Contact Queueing Settings",
      "properties": {
        "sort": {
          "type": "boolean",
          "description": "Whether to sort contacts dynamically"
        },
        "filter": {
          "type": "boolean",
          "description": "Whether to filter contacts dynamically"
        }
      }
    },
    "dynamicLineBalancingSettings": {
      "type": "object",
      "description": "Dynamic Line Balancing Settings",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Indicates that this campaign is subject of dynamic line balancing"
        },
        "relativeWeight": {
          "type": "integer",
          "description": "Relative weight of this campaign in dynamic line balancing"
        }
      }
    },
    "edgeGroup": {
      "type": "object",
      "description": "Edge Group",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "description": "name of the error"
          },
          "details": {
            "type": "string",
            "description": "additional information regarding the error"
          },
          "userParams": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            },
            "description": "parameters to be inserted into details."
          }
        },
        "required": [
          "error"
        ]
      },
      "description": "A list of current error conditions associated with the campaign."
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "maxCallsPerAgent": {
      "type": "integer",
      "description": "The maximum number of calls that can be placed per agent on this campaign"
    },
    "maxCallsPerAgentDecimal": {
      "type": "number",
      "description": "The maximum number of calls that can be placed per agent on this campaign with decimal precision"
    },
    "name": {
      "type": "string",
      "description": "The name of the Campaign."
    },
    "noAnswerTimeout": {
      "type": "integer",
      "description": "How long to wait before dispositioning a call as 'no-answer'. Default 30 seconds. Only applicable to non-preview campaigns."
    },
    "outboundLineCount": {
      "type": "integer",
      "description": "The number of outbound lines to be concurrently dialed. Only applicable to non-preview campaigns; only required for agentless."
    },
    "phoneColumns": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "columnName": {
            "type": "string",
            "description": "The name of the phone column."
          },
          "type": {
            "type": "string",
            "description": "The type of the phone column. For example, 'cell' or 'home'."
          }
        },
        "required": [
          "columnName",
          "type"
        ]
      },
      "description": "The ContactPhoneNumberColumns on the ContactList that this Campaign should dial."
    },
    "previewAutoEnd": {
      "type": "boolean",
      "description": "Option to enable preview auto end"
    },
    "previewTimeOutSeconds": {
      "type": "integer",
      "description": "The number of seconds before a call will be automatically placed on a preview. A value of 0 indicates no automatic placement of calls. Only applicable to preview campaigns."
    },
    "priority": {
      "type": "integer",
      "description": "The priority of this campaign relative to other campaigns that are running on the same queue. 5 is the highest priority, 1 the lowest."
    },
    "queue": {
      "type": "object",
      "description": "The queue value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "ruleSets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "name": {
            "type": "string",
            "description": "The name value"
          },
          "selfUri": {
            "type": "string",
            "format": "uri",
            "description": "Self Uri"
          }
        }
      },
      "description": "Rule sets to be applied while this campaign is dialing."
    },
    "script": {
      "type": "object",
      "description": "The script value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "site": {
      "type": "object",
      "description": "The site value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "skillColumns": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The skill columns on the ContactList that this Campaign should take into account when dialing"
    },
    "skipPreviewDisabled": {
      "type": "boolean",
      "description": "Whether or not agents can skip previews without placing a call. Only applicable for preview campaigns."
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "campaignId",
    "callerAddress",
    "callerName",
    "contactList",
    "dialingMode",
    "name",
    "phoneColumns"
  ]
}

genesys-outbound_put_campaign_agent

Send notification that an agent’s state changed Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	string	Yes	—	Campaign ID
`userId`	string	Yes	—	Agent’s user ID
`stage`	string	No	—	The current stage for this agent

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "string",
      "description": "Campaign ID"
    },
    "userId": {
      "type": "string",
      "description": "Agent's user ID"
    },
    "stage": {
      "type": "string",
      "description": "The current stage for this agent"
    }
  },
  "required": [
    "PCID",
    "campaignId",
    "userId"
  ]
}

genesys-outbound_put_campaignrule

Update Campaign Rule Parameters:

Parameter	Type	Required	Default	Description
`campaignRuleId`	string	Yes	—	Campaign Rule ID
`campaignRuleActions`	object[]	Yes	—	The list of actions that are executed if the conditions are satisfied.
`campaignRuleConditions`	object[]	Yes	—	The list of conditions that are evaluated on the entities.
`campaignRuleEntities`	object	Yes	—	Campaign Rule Entities
`campaignRuleProcessing`	string	No	—	CampaignRule processing algorithm
`conditionGroups`	object[]	No	—	List of condition groups that are evaluated, used only with campaignRuleProcessing=“v2”
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`enabled`	boolean	No	—	Whether or not this CampaignRule is currently enabled. Required on updates.
`executionSettings`	object	No	—	Execution Settings
`id`	string	No	—	The globally unique identifier for the object.
`matchAnyConditions`	boolean	No	—	Match Any Conditions
`name`	string	Yes	—	The name of the CampaignRule.
`selfUri`	string	No	—	The URI for this object
`timeZoneId`	string	No	—	The time zone to use for date-time conditions.
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update
`warnings`	object[]	No	—	A list of current warning conditions associated with the campaign rule.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignRuleId": {
      "type": "string",
      "description": "Campaign Rule ID"
    },
    "campaignRuleActions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "parameters": {
            "type": "object",
            "description": "The parameters value"
          },
          "actionType": {
            "type": "string",
            "enum": [
              "turnOnCampaign",
              "turnOffCampaign",
              "turnOnSequence",
              "turnOffSequence",
              "setCampaignPriority",
              "recycleCampaign",
              "setCampaignDialingMode",
              "setCampaignAbandonRate",
              "setCampaignNumberOfLines",
              "setCampaignWeight",
              "setCampaignMaxCallsPerAgent",
              "setCampaignMessagesPerMinute",
              "changeCampaignQueue",
              "changeCampaignTemplate"
            ],
            "description": "The action to take on the campaignRuleActionEntities."
          },
          "campaignRuleActionEntities": {
            "type": "object",
            "description": "Campaign Rule Action Entities"
          }
        },
        "required": [
          "actionType",
          "campaignRuleActionEntities"
        ]
      },
      "description": "The list of actions that are executed if the conditions are satisfied."
    },
    "campaignRuleConditions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "parameters": {
            "type": "object",
            "description": "The parameters value"
          },
          "conditionType": {
            "type": "string",
            "enum": [
              "campaignProgress",
              "campaignAgents",
              "campaignRecordsAttempted",
              "campaignContactsMessaged",
              "campaignBusinessSuccess",
              "campaignBusinessFailure",
              "campaignBusinessNeutral",
              "campaignValidAttempts",
              "campaignRightPartyContacts",
              "timeOfDay",
              "dayOfWeek",
              "dayOfMonth",
              "weekDayOfMonth",
              "specificDate",
              "campaignRunTime",
              "campaignWaitTime"
            ],
            "description": "The type of condition to evaluate."
          },
          "dateTimeParameters": {
            "type": "object",
            "description": "Date Time Parameters"
          },
          "campaignRunTimeSettings": {
            "type": "object",
            "description": "Campaign Run Time Settings"
          },
          "campaignWaitTimeSettings": {
            "type": "object",
            "description": "Campaign Wait Time Settings"
          }
        },
        "required": [
          "conditionType",
          "parameters"
        ]
      },
      "description": "The list of conditions that are evaluated on the entities."
    },
    "campaignRuleEntities": {
      "type": "object",
      "description": "Campaign Rule Entities",
      "properties": {
        "campaigns": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The list of campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a campaign."
        },
        "sequences": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The list of sequences for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a sequence."
        },
        "emailCampaigns": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The list of Email campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a Email campaign."
        },
        "smsCampaigns": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The list of SMS campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a SMS campaign."
        }
      }
    },
    "campaignRuleProcessing": {
      "type": "string",
      "description": "CampaignRule processing algorithm",
      "enum": [
        "v2"
      ]
    },
    "conditionGroups": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "matchAnyConditions": {
            "type": "boolean",
            "description": "Whether or not this condition group should be evaluated as true if any of sub conditions is matched"
          },
          "conditions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "parameters": {
                  "type": "object"
                },
                "conditionType": {
                  "type": "string",
                  "description": "The type of condition to evaluate."
                },
                "dateTimeParameters": {
                  "type": "object"
                },
                "campaignRunTimeSettings": {
                  "type": "object"
                },
                "campaignWaitTimeSettings": {
                  "type": "object"
                }
              }
            },
            "description": "The parameters for the CampaignRuleCondition."
          }
        },
        "required": [
          "conditions",
          "matchAnyConditions"
        ]
      },
      "description": "List of condition groups that are evaluated, used only with campaignRuleProcessing=\"v2\""
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether or not this CampaignRule is currently enabled. Required on updates."
    },
    "executionSettings": {
      "type": "object",
      "description": "Execution Settings",
      "properties": {
        "frequency": {
          "type": "string",
          "description": "Execution control frequency",
          "enum": [
            "onEachTrigger",
            "oncePerDay"
          ]
        },
        "timeZoneId": {
          "type": "string",
          "description": "The time zone for the execution control frequency=\"oncePerDay\"; for example, Africa/Abidjan. This property is ignored when frequency is not \"oncePerDay\""
        }
      },
      "required": [
        "frequency"
      ]
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "matchAnyConditions": {
      "type": "boolean",
      "description": "Match Any Conditions"
    },
    "name": {
      "type": "string",
      "description": "The name of the CampaignRule."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "timeZoneId": {
      "type": "string",
      "description": "The time zone to use for date-time conditions."
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "enum": [
              "ConditionsNoEntities",
              "ConditionsNoSequences",
              "ConditionsNoCampaigns",
              "ConditionsNoMessagingCampaigns",
              "ActionNoEntities",
              "ActionNoSequences",
              "ActionNoCampaigns",
              "ActionNoMessagingCampaigns",
              "NoQueue",
              "NoContentTemplates",
              "NoSmsContentTemplate",
              "NoEmailContentTemplate",
              "ConditionsWaitingForLinesOnlyPreviewOrExternal",
              "ConditionsWaitingForAgentsOnlyAgentless"
            ],
            "description": "Warning code for this warning."
          },
          "message": {
            "type": "string",
            "description": "Warning message for this warning."
          },
          "params": {
            "type": "object",
            "description": "The params value"
          }
        },
        "required": [
          "code",
          "message"
        ]
      },
      "description": "A list of current warning conditions associated with the campaign rule."
    }
  },
  "required": [
    "PCID",
    "campaignRuleId",
    "campaignRuleActions",
    "campaignRuleConditions",
    "campaignRuleEntities",
    "name"
  ]
}

genesys-outbound_put_contactlist

Update a contact list. Parameters:

Parameter	Type	Required	Default	Description
`contactListId`	string	Yes	—	ContactList ID
`attemptLimits`	object	No	—	Attempt Limits
`automaticTimeZoneMapping`	boolean	No	—	Indicates if automatic time zone mapping is to be used for this ContactList.
`columnDataTypeSpecifications`	object[]	No	—	The settings of the columns selected for dynamic queueing
`columnNames`	string[]	Yes	—	The names of the contact data columns.
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`division`	object	No	—	The division value
`emailColumns`	object[]	No	—	Indicates which columns are email addresses
`id`	string	No	—	The globally unique identifier for the object.
`importStatus`	object	No	—	Import Status
`name`	string	No	—	The name value
`phoneColumns`	object[]	No	—	Indicates which columns are phone numbers.
`previewModeAcceptedValues`	string[]	No	—	The values in the previewModeColumnName column that indicate a contact should always be dialed in preview mode.
`previewModeColumnName`	string	No	—	A column to check if a contact should always be dialed in preview mode.
`selfUri`	string	No	—	The URI for this object
`size`	integer	No	—	The number of contacts in the ContactList.
`trimWhitespace`	boolean	No	—	Whether to trim white space when importing a contactlist csv file, default value = true
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update
`whatsAppColumns`	object[]	No	—	Indicates which columns are whatsApp contacts
`zipCodeColumnName`	string	No	—	The name of contact list column containing the zip code for use with automatic time zone mapping. Only allowed if ‘automaticTimeZoneMapping’ is set to true.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListId": {
      "type": "string",
      "description": "ContactList ID"
    },
    "attemptLimits": {
      "type": "object",
      "description": "Attempt Limits",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "automaticTimeZoneMapping": {
      "type": "boolean",
      "description": "Indicates if automatic time zone mapping is to be used for this ContactList."
    },
    "columnDataTypeSpecifications": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "columnName": {
            "type": "string",
            "description": "The column name of a column selected for dynamic queueing"
          },
          "columnDataType": {
            "type": "string",
            "enum": [
              "NUMERIC",
              "TEXT",
              "TIMESTAMP"
            ],
            "description": "The data type of the column selected for dynamic queueing (TEXT, NUMERIC or TIMESTAMP)"
          },
          "min": {
            "type": "integer",
            "format": "int32",
            "description": "The minimum length of the numeric column selected for dynamic queueing"
          },
          "max": {
            "type": "integer",
            "format": "int32",
            "description": "The maximum length of the numeric column selected for dynamic queueing"
          },
          "maxLength": {
            "type": "integer",
            "format": "int32",
            "description": "The maximum length of the text column selected for dynamic queueing"
          }
        }
      },
      "description": "The settings of the columns selected for dynamic queueing"
    },
    "columnNames": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The names of the contact data columns."
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "division": {
      "type": "object",
      "description": "The division value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "emailColumns": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "columnName": {
            "type": "string",
            "description": "The name of the email column."
          },
          "type": {
            "type": "string",
            "description": "Indicates the type of the email column. For example, 'work' or 'personal'."
          },
          "contactableTimeColumnName": {
            "type": "string",
            "description": "A name of the contactableTimeColumn"
          },
          "contactableTimeColumn": {
            "type": "string",
            "description": "A column that indicates the timezone to use for a given contact when checking contactable times."
          }
        },
        "required": [
          "columnName",
          "type"
        ]
      },
      "description": "Indicates which columns are email addresses"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "importStatus": {
      "type": "object",
      "description": "Import Status",
      "properties": {
        "state": {
          "type": "string",
          "description": "current status of the import",
          "enum": [
            "IN_PROGRESS",
            "FAILED"
          ]
        },
        "totalRecords": {
          "type": "integer",
          "description": "total number of records to be imported"
        },
        "completedRecords": {
          "type": "integer",
          "description": "number of records finished importing"
        },
        "percentComplete": {
          "type": "integer",
          "description": "percentage of records finished importing"
        },
        "failureReason": {
          "type": "string",
          "description": "if the import has failed, the reason for the failure"
        },
        "targetContactListIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The contact list Ids for target contact lists."
        },
        "listNamePrefix": {
          "type": "string",
          "description": "The prefix for the contact list name"
        }
      },
      "required": [
        "completedRecords",
        "percentComplete",
        "state",
        "totalRecords"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "phoneColumns": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "columnName": {
            "type": "string",
            "description": "The name of the phone column."
          },
          "type": {
            "type": "string",
            "description": "Indicates the type of the phone column. For example, 'cell' or 'home'."
          },
          "callableTimeColumnName": {
            "type": "string",
            "description": "A name of the callableTimeColumn"
          },
          "callableTimeColumn": {
            "type": "string",
            "description": "A column that indicates the timezone to use for a given contact when checking callable times. Not allowed if 'automaticTimeZoneMapping' is set to true."
          }
        },
        "required": [
          "columnName",
          "type"
        ]
      },
      "description": "Indicates which columns are phone numbers."
    },
    "previewModeAcceptedValues": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The values in the previewModeColumnName column that indicate a contact should always be dialed in preview mode."
    },
    "previewModeColumnName": {
      "type": "string",
      "description": "A column to check if a contact should always be dialed in preview mode."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "size": {
      "type": "integer",
      "description": "The number of contacts in the ContactList."
    },
    "trimWhitespace": {
      "type": "boolean",
      "description": "Whether to trim white space when importing a contactlist csv file, default value = true"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    },
    "whatsAppColumns": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "columnName": {
            "type": "string",
            "description": "The name of the whatsApp column."
          },
          "type": {
            "type": "string",
            "description": "Indicates the type of the whatsApp column. For example, 'work' or 'personal'."
          },
          "contactableTimeColumnName": {
            "type": "string",
            "description": "A name of the contactableTimeColumn"
          },
          "contactableTimeColumn": {
            "type": "string",
            "description": "A column that indicates the timezone to use for a given contact when checking contactable times."
          }
        },
        "required": [
          "columnName",
          "type"
        ]
      },
      "description": "Indicates which columns are whatsApp contacts"
    },
    "zipCodeColumnName": {
      "type": "string",
      "description": "The name of contact list column containing the zip code for use with automatic time zone mapping. Only allowed if 'automaticTimeZoneMapping' is set to true."
    }
  },
  "required": [
    "PCID",
    "contactListId",
    "columnNames"
  ]
}

genesys-outbound_put_contactlist_contact

Update a contact. Parameters:

Parameter	Type	Required	Default	Description
`contactListId`	string	Yes	—	Contact List ID
`contactId`	string	Yes	—	Contact ID
`callable`	boolean	No	—	Indicates whether or not the contact can be called.
`callRecords`	object	No	—	A map of call records for the contact phone columns.
`configurationOverrides`	object	No	—	Configuration Overrides
`contactableStatus`	object	No	—	A map of media types (Voice, SMS and Email) to ContactableStatus, which indicates if the contact can be contacted using the specified media type.
`contactColumnTimeZones`	object	No	—	Map containing data about the timezone the contact is mapped to. This will only be populated if the contact list has automatic timezone mapping turned on. The key is the column name. The value is the timezone it mapped to and the type of column: Phone or Zip
`data`	object	Yes	—	An ordered map of the contact’s columns and corresponding values.
`dateCreated`	string	No	—	Timestamp for when the contact was added. Contacts added prior to 2023 September 1 may be missing this value. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`id`	string	No	—	The globally unique identifier for the object.
`latestEmailEvaluations`	object	No	—	A map of email records for the contact email columns.
`latestSmsEvaluations`	object	No	—	A map of SMS records for the contact phone columns.
`latestWhatsAppEvaluations`	object	No	—	A map of whatsapp records for the contact whatsapp columns.
`name`	string	No	—	The name value
`phoneNumberStatus`	object	No	—	A map of phone number columns to PhoneNumberStatuses, which indicate if the phone number is callable or not.
`selfUri`	string	No	—	The URI for this object

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListId": {
      "type": "string",
      "description": "Contact List ID"
    },
    "contactId": {
      "type": "string",
      "description": "Contact ID"
    },
    "callable": {
      "type": "boolean",
      "description": "Indicates whether or not the contact can be called."
    },
    "callRecords": {
      "type": "object",
      "description": "A map of call records for the contact phone columns."
    },
    "configurationOverrides": {
      "type": "object",
      "description": "Configuration Overrides",
      "properties": {
        "priority": {
          "type": "boolean",
          "description": "Indicates whether or not the contact will be placed in front of the queue or at the end of the queue."
        }
      }
    },
    "contactableStatus": {
      "type": "object",
      "description": "A map of media types (Voice, SMS and Email) to ContactableStatus, which indicates if the contact can be contacted using the specified media type."
    },
    "contactColumnTimeZones": {
      "type": "object",
      "description": "Map containing data about the timezone the contact is mapped to. This will only be populated if the contact list has automatic timezone mapping turned on. The key is the column name. The value is the timezone it mapped to and the type of column: Phone or Zip"
    },
    "data": {
      "type": "object",
      "description": "An ordered map of the contact's columns and corresponding values."
    },
    "dateCreated": {
      "type": "string",
      "description": "Timestamp for when the contact was added. Contacts added prior to 2023 September 1 may be missing this value. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "latestEmailEvaluations": {
      "type": "object",
      "description": "A map of email records for the contact email columns."
    },
    "latestSmsEvaluations": {
      "type": "object",
      "description": "A map of SMS records for the contact phone columns."
    },
    "latestWhatsAppEvaluations": {
      "type": "object",
      "description": "A map of whatsapp records for the contact whatsapp columns."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "phoneNumberStatus": {
      "type": "object",
      "description": "A map of phone number columns to PhoneNumberStatuses, which indicate if the phone number is callable or not."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    }
  },
  "required": [
    "PCID",
    "contactListId",
    "contactId",
    "data"
  ]
}

genesys-outbound_put_contactlistfilter

Update Contact List Filter Parameters:

Parameter	Type	Required	Default	Description
`contactListFilterId`	string	Yes	—	Contact List Filter ID
`clauses`	object[]	No	—	Groups of conditions to filter the contacts by.
`contactList`	object	No	—	Contact List
`contactListTemplate`	object	No	—	Contact List Template
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`filterType`	string	No	—	How to join clauses together.
`id`	string	No	—	The globally unique identifier for the object.
`name`	string	Yes	—	The name of the list.
`selfUri`	string	No	—	The URI for this object
`sourceType`	string	No	—	The source type the filter is based on.
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListFilterId": {
      "type": "string",
      "description": "Contact List Filter ID"
    },
    "clauses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "filterType": {
            "type": "string",
            "enum": [
              "AND",
              "OR"
            ],
            "description": "How to join predicates together."
          },
          "predicates": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "column": {
                  "type": "string",
                  "description": "Contact list column from the ContactListFilter's contactList."
                },
                "columnType": {
                  "type": "string",
                  "description": "The type of data in the contact column."
                },
                "operator": {
                  "type": "string",
                  "description": "The operator for this ContactListFilterPredicate."
                },
                "value": {
                  "type": "string",
                  "description": "Value with which to compare the contact's data. This could be text, a number, or a relative time. A value for relative time should follow the format PxxDTyyHzzM, where xx, yy, and zz specify the days, hours and minutes. For example, a value of P01DT08H30M corresponds to 1 day, 8 hours, and 30 minutes from now. To specify a time in the past, include a negative sign before each numeric value. For example, a value of P-01DT-08H-30M corresponds to 1 day, 8 hours, and 30 minutes in the past. You can also do things like P01DT00H-30M, which would correspond to 23 hours and 30 minutes from now (1 day - 30 minutes)."
                },
                "range": {
                  "type": "object"
                },
                "inverted": {
                  "type": "boolean",
                  "description": "Inverts the result of the predicate (i.e., if the predicate returns true, inverting it will return false)."
                }
              }
            },
            "description": "Conditions to filter the contacts by."
          }
        }
      },
      "description": "Groups of conditions to filter the contacts by."
    },
    "contactList": {
      "type": "object",
      "description": "Contact List",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "contactListTemplate": {
      "type": "object",
      "description": "Contact List Template",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "filterType": {
      "type": "string",
      "description": "How to join clauses together.",
      "enum": [
        "AND",
        "OR"
      ]
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "name": {
      "type": "string",
      "description": "The name of the list."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "sourceType": {
      "type": "string",
      "description": "The source type the filter is based on.",
      "enum": [
        "ContactList",
        "ContactListTemplate"
      ]
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "contactListFilterId",
    "name"
  ]
}

genesys-outbound_put_contactlisttemplate

Update a contact list template. Parameters:

Parameter	Type	Required	Default	Description
`contactListTemplateId`	string	Yes	—	ContactListTemplate ID
`attemptLimits`	object	No	—	Attempt Limits
`automaticTimeZoneMapping`	boolean	No	—	Indicates if automatic time zone mapping is to be used for this ContactListTemplate.
`columnDataTypeSpecifications`	object[]	No	—	The settings of the columns selected for dynamic queueing
`columnNames`	string[]	Yes	—	The names of the contact data columns.
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`emailColumns`	object[]	No	—	Indicates which columns are email addresses
`id`	string	No	—	The globally unique identifier for the object.
`name`	string	No	—	The name value
`phoneColumns`	object[]	No	—	Indicates which columns are phone numbers.
`previewModeAcceptedValues`	string[]	No	—	The values in the previewModeColumnName column that indicate a contact should always be dialed in preview mode.
`previewModeColumnName`	string	No	—	A column to check if a contact should always be dialed in preview mode.
`selfUri`	string	No	—	The URI for this object
`trimWhitespace`	boolean	No	—	Whether to trim white space when importing a ContactListTemplate csv file, default value = true
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update
`whatsAppColumns`	object[]	No	—	Indicates which columns are whatsApp contacts
`zipCodeColumnName`	string	No	—	The name of ContactListTemplate column containing the zip code for use with automatic time zone mapping. Only allowed if ‘automaticTimeZoneMapping’ is set to true.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactListTemplateId": {
      "type": "string",
      "description": "ContactListTemplate ID"
    },
    "attemptLimits": {
      "type": "object",
      "description": "Attempt Limits",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "automaticTimeZoneMapping": {
      "type": "boolean",
      "description": "Indicates if automatic time zone mapping is to be used for this ContactListTemplate."
    },
    "columnDataTypeSpecifications": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "columnName": {
            "type": "string",
            "description": "The column name of a column selected for dynamic queueing"
          },
          "columnDataType": {
            "type": "string",
            "enum": [
              "NUMERIC",
              "TEXT",
              "TIMESTAMP"
            ],
            "description": "The data type of the column selected for dynamic queueing (TEXT, NUMERIC or TIMESTAMP)"
          },
          "min": {
            "type": "integer",
            "format": "int32",
            "description": "The minimum length of the numeric column selected for dynamic queueing"
          },
          "max": {
            "type": "integer",
            "format": "int32",
            "description": "The maximum length of the numeric column selected for dynamic queueing"
          },
          "maxLength": {
            "type": "integer",
            "format": "int32",
            "description": "The maximum length of the text column selected for dynamic queueing"
          }
        }
      },
      "description": "The settings of the columns selected for dynamic queueing"
    },
    "columnNames": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The names of the contact data columns."
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "emailColumns": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "columnName": {
            "type": "string",
            "description": "The name of the email column."
          },
          "type": {
            "type": "string",
            "description": "Indicates the type of the email column. For example, 'work' or 'personal'."
          },
          "contactableTimeColumnName": {
            "type": "string",
            "description": "A name of the contactableTimeColumn"
          },
          "contactableTimeColumn": {
            "type": "string",
            "description": "A column that indicates the timezone to use for a given contact when checking contactable times."
          }
        },
        "required": [
          "columnName",
          "type"
        ]
      },
      "description": "Indicates which columns are email addresses"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "phoneColumns": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "columnName": {
            "type": "string",
            "description": "The name of the phone column."
          },
          "type": {
            "type": "string",
            "description": "Indicates the type of the phone column. For example, 'cell' or 'home'."
          },
          "callableTimeColumnName": {
            "type": "string",
            "description": "A name of the callableTimeColumn"
          },
          "callableTimeColumn": {
            "type": "string",
            "description": "A column that indicates the timezone to use for a given contact when checking callable times. Not allowed if 'automaticTimeZoneMapping' is set to true."
          }
        },
        "required": [
          "columnName",
          "type"
        ]
      },
      "description": "Indicates which columns are phone numbers."
    },
    "previewModeAcceptedValues": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The values in the previewModeColumnName column that indicate a contact should always be dialed in preview mode."
    },
    "previewModeColumnName": {
      "type": "string",
      "description": "A column to check if a contact should always be dialed in preview mode."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "trimWhitespace": {
      "type": "boolean",
      "description": "Whether to trim white space when importing a ContactListTemplate csv file, default value = true"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    },
    "whatsAppColumns": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "columnName": {
            "type": "string",
            "description": "The name of the whatsApp column."
          },
          "type": {
            "type": "string",
            "description": "Indicates the type of the whatsApp column. For example, 'work' or 'personal'."
          },
          "contactableTimeColumnName": {
            "type": "string",
            "description": "A name of the contactableTimeColumn"
          },
          "contactableTimeColumn": {
            "type": "string",
            "description": "A column that indicates the timezone to use for a given contact when checking contactable times."
          }
        },
        "required": [
          "columnName",
          "type"
        ]
      },
      "description": "Indicates which columns are whatsApp contacts"
    },
    "zipCodeColumnName": {
      "type": "string",
      "description": "The name of ContactListTemplate column containing the zip code for use with automatic time zone mapping. Only allowed if 'automaticTimeZoneMapping' is set to true."
    }
  },
  "required": [
    "PCID",
    "contactListTemplateId",
    "columnNames"
  ]
}

genesys-outbound_put_digitalruleset

Update an Outbound Digital Rule Set Parameters:

Parameter	Type	Required	Default	Description
`digitalRuleSetId`	string	Yes	—	The Digital Rule Set ID
`contactList`	object	No	—	Contact List
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`id`	string	No	—	The globally unique identifier for the object.
`name`	string	No	—	The name value
`rules`	object[]	Yes	—	The list of rules.
`selfUri`	string	No	—	The URI for this object
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "digitalRuleSetId": {
      "type": "string",
      "description": "The Digital Rule Set ID"
    },
    "contactList": {
      "type": "object",
      "description": "Contact List",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "rules": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The identifier of the rule."
          },
          "name": {
            "type": "string",
            "description": "The name of the rule."
          },
          "order": {
            "type": "integer",
            "format": "int32",
            "description": "The ranked order of the rule. Rules are processed from lowest number to highest."
          },
          "category": {
            "type": "string",
            "enum": [
              "PreContact",
              "PostContact"
            ],
            "description": "The category of the rule."
          },
          "conditions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "inverted": {
                  "type": "boolean",
                  "description": "If true, inverts the result of evaluating this condition. Default is false."
                },
                "contactColumnConditionSettings": {
                  "type": "object"
                },
                "contactAddressConditionSettings": {
                  "type": "object"
                },
                "contactAddressTypeConditionSettings": {
                  "type": "object"
                },
                "lastAttemptByColumnConditionSettings": {
                  "type": "object"
                },
                "lastAttemptOverallConditionSettings": {
                  "type": "object"
                },
                "lastResultByColumnConditionSettings": {
                  "type": "object"
                },
                "lastResultOverallConditionSettings": {
                  "type": "object"
                },
                "dataActionConditionSettings": {
                  "type": "object"
                }
              }
            },
            "description": "A list of conditions to evaluate. All of the Conditions must evaluate to true to trigger the actions."
          },
          "actions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "updateContactColumnActionSettings": {
                  "type": "object"
                },
                "doNotSendActionSettings": {
                  "type": "object"
                },
                "appendToDncActionSettings": {
                  "type": "object"
                },
                "markContactUncontactableActionSettings": {
                  "type": "object"
                },
                "markContactAddressUncontactableActionSettings": {
                  "type": "object"
                },
                "setContentTemplateActionSettings": {
                  "type": "object"
                },
                "setSmsPhoneNumberActionSettings": {
                  "type": "object"
                },
                "setWhatsAppIntegrationActionSettings": {
                  "type": "object"
                }
              }
            },
            "description": "The list of actions to be taken if all conditions are true."
          }
        },
        "required": [
          "actions",
          "category",
          "conditions",
          "name",
          "order"
        ]
      },
      "description": "The list of rules."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "digitalRuleSetId",
    "rules"
  ]
}

genesys-outbound_put_dnclist

Update dialer DNC list Parameters:

Parameter	Type	Required	Default	Description
`dncListId`	string	Yes	—	DncList ID
`campaignId`	string	No	—	A dnc.com campaignId. Optional if the dncSourceType is dnc.com.
`contactMethod`	string	No	—	The contact method. Required if dncSourceType is rds.
`customExclusionColumn`	string	No	—	The column to evaluate exclusion against. Required if the dncSourceType is rds_custom.
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`division`	object	No	—	The division value
`dncCodes`	string[]	No	—	The list of dnc.com codes to be treated as DNC. Required if the dncSourceType is dnc.com.
`dncSourceType`	string	Yes	—	The type of the DncList.
`id`	string	No	—	The globally unique identifier for the object.
`importStatus`	object	No	—	Import Status
`licenseId`	string	No	—	A gryphon license number. Required if the dncSourceType is gryphon.
`loginId`	string	No	—	A dnc.com loginId. Required if the dncSourceType is dnc.com.
`name`	string	Yes	—	The name of the DncList.
`selfUri`	string	No	—	The URI for this object
`size`	integer	No	—	The total number of phone numbers in the DncList.
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dncListId": {
      "type": "string",
      "description": "DncList ID"
    },
    "campaignId": {
      "type": "string",
      "description": "A dnc.com campaignId. Optional if the dncSourceType is dnc.com."
    },
    "contactMethod": {
      "type": "string",
      "description": "The contact method. Required if dncSourceType is rds.",
      "enum": [
        "Email",
        "Phone",
        "Any",
        "WhatsApp"
      ]
    },
    "customExclusionColumn": {
      "type": "string",
      "description": "The column to evaluate exclusion against. Required if the dncSourceType is rds_custom."
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "division": {
      "type": "object",
      "description": "The division value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "dncCodes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of dnc.com codes to be treated as DNC. Required if the dncSourceType is dnc.com."
    },
    "dncSourceType": {
      "type": "string",
      "description": "The type of the DncList.",
      "enum": [
        "rds",
        "rds_custom",
        "dnc.com",
        "gryphon"
      ]
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "importStatus": {
      "type": "object",
      "description": "Import Status",
      "properties": {
        "state": {
          "type": "string",
          "description": "current status of the import",
          "enum": [
            "IN_PROGRESS",
            "FAILED"
          ]
        },
        "totalRecords": {
          "type": "integer",
          "description": "total number of records to be imported"
        },
        "completedRecords": {
          "type": "integer",
          "description": "number of records finished importing"
        },
        "percentComplete": {
          "type": "integer",
          "description": "percentage of records finished importing"
        },
        "failureReason": {
          "type": "string",
          "description": "if the import has failed, the reason for the failure"
        },
        "targetContactListIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The contact list Ids for target contact lists."
        },
        "listNamePrefix": {
          "type": "string",
          "description": "The prefix for the contact list name"
        }
      },
      "required": [
        "completedRecords",
        "percentComplete",
        "state",
        "totalRecords"
      ]
    },
    "licenseId": {
      "type": "string",
      "description": "A gryphon license number. Required if the dncSourceType is gryphon."
    },
    "loginId": {
      "type": "string",
      "description": "A dnc.com loginId. Required if the dncSourceType is dnc.com."
    },
    "name": {
      "type": "string",
      "description": "The name of the DncList."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "size": {
      "type": "integer",
      "description": "The total number of phone numbers in the DncList."
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "dncListId",
    "dncSourceType",
    "name"
  ]
}

genesys-outbound_put_filespecificationtemplate

Update File Specification Template Parameters:

Parameter	Type	Required	Default	Description
`fileSpecificationTemplateId`	string	Yes	—	File Specification Template ID
`columnInformation`	object[]	No	—	Columns specification
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`delimiter`	string	No	—	Kind of delimiter
`delimiterValue`	string	No	—	Delimiter character, used only when delimiter=“Custom”
`description`	string	No	—	Description of the file specification template
`format`	string	Yes	—	File format
`header`	boolean	No	—	If true indicates that delimited file has a header row, which can provide column names
`id`	string	No	—	The globally unique identifier for the object.
`name`	string	Yes	—	The name of the File Specification template.
`numberOfHeadingLinesSkipped`	integer	No	—	Number of heading lines to be skipped
`numberOfTrailingLinesSkipped`	integer	No	—	Number of trailing lines to be skipped
`preprocessingRules`	object[]	No	—	Preprocessing rules
`selfUri`	string	No	—	The URI for this object
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fileSpecificationTemplateId": {
      "type": "string",
      "description": "File Specification Template ID"
    },
    "columnInformation": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "columnName": {
            "type": "string",
            "description": "Column name. Mandatory for Fixed position/length file format."
          },
          "columnNumber": {
            "type": "integer",
            "format": "int32",
            "description": "0 based column number in delimited file format"
          },
          "startPosition": {
            "type": "integer",
            "format": "int32",
            "description": "Zero-based position of the first column's character. Mandatory for Fixed position/length file format."
          },
          "length": {
            "type": "integer",
            "format": "int32",
            "description": "Column width. Mandatory for Fixed position/length file format."
          }
        }
      },
      "description": "Columns specification"
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "delimiter": {
      "type": "string",
      "description": "Kind of delimiter",
      "enum": [
        "Comma",
        "Pipe",
        "Colon",
        "Tab",
        "Semicolon",
        "Custom"
      ]
    },
    "delimiterValue": {
      "type": "string",
      "description": "Delimiter character, used only when delimiter=\"Custom\""
    },
    "description": {
      "type": "string",
      "description": "Description of the file specification template"
    },
    "format": {
      "type": "string",
      "description": "File format",
      "enum": [
        "FixedLength",
        "Delimited"
      ]
    },
    "header": {
      "type": "boolean",
      "description": "If true indicates that delimited file has a header row, which can provide column names"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "name": {
      "type": "string",
      "description": "The name of the File Specification template."
    },
    "numberOfHeadingLinesSkipped": {
      "type": "integer",
      "description": "Number of heading lines to be skipped"
    },
    "numberOfTrailingLinesSkipped": {
      "type": "integer",
      "description": "Number of trailing lines to be skipped"
    },
    "preprocessingRules": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "find": {
            "type": "string",
            "description": "The regular expression to which file lines are to be matched."
          },
          "replaceWith": {
            "type": "string",
            "description": "The string to be substituted for each match."
          },
          "global": {
            "type": "boolean",
            "description": "Replaces all matching substrings in every line."
          },
          "ignoreCase": {
            "type": "boolean",
            "description": "Enables case-insensitive matching"
          }
        }
      },
      "description": "Preprocessing rules"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "fileSpecificationTemplateId",
    "format",
    "name"
  ]
}

genesys-outbound_put_importtemplate

Update Import Template Parameters:

Parameter	Type	Required	Default	Description
`importTemplateId`	string	Yes	—	Import Template ID
`contactListFilter`	object	No	—	Contact List Filter
`contactListTemplate`	object	Yes	—	Contact List Template
`customListNameFormatValue`	string	No	—	Custom value for the list name format, at least %N is required. Any character other than the specified tokens will be used as is. Available tokens: %N: ListNamePrefix; %P: Part number; %F: Filter name; %C: Column value; YYYY: year; MM: month; DD: day; hh: hour; mm: minute; ss: second.
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`id`	string	No	—	The globally unique identifier for the object.
`importStatus`	object	No	—	Import Status
`listNameFormat`	string	No	—	The list name format for target ContactLists. When Custom is provided, customListNameFormatValue is required.
`name`	string	No	—	The name of the import template.
`selfUri`	string	No	—	The URI for this object
`splittingInformation`	object	No	—	Splitting Information
`useSplittingCriteria`	boolean	No	—	Whether or not to use splitting criteria. Default is false.
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "importTemplateId": {
      "type": "string",
      "description": "Import Template ID"
    },
    "contactListFilter": {
      "type": "object",
      "description": "Contact List Filter",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "contactListTemplate": {
      "type": "object",
      "description": "Contact List Template",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "customListNameFormatValue": {
      "type": "string",
      "description": "Custom value for the list name format, at least %N is required. Any character other than the specified tokens will be used as is. Available tokens: %N: ListNamePrefix; %P: Part number; %F: Filter name; %C: Column value; YYYY: year; MM: month; DD: day; hh: hour; mm: minute; ss: second."
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "importStatus": {
      "type": "object",
      "description": "Import Status",
      "properties": {
        "state": {
          "type": "string",
          "description": "current status of the import",
          "enum": [
            "IN_PROGRESS",
            "FAILED"
          ]
        },
        "totalRecords": {
          "type": "integer",
          "description": "total number of records to be imported"
        },
        "completedRecords": {
          "type": "integer",
          "description": "number of records finished importing"
        },
        "percentComplete": {
          "type": "integer",
          "description": "percentage of records finished importing"
        },
        "failureReason": {
          "type": "string",
          "description": "if the import has failed, the reason for the failure"
        },
        "targetContactListIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The contact list Ids for target contact lists."
        },
        "listNamePrefix": {
          "type": "string",
          "description": "The prefix for the contact list name"
        }
      },
      "required": [
        "completedRecords",
        "percentComplete",
        "state",
        "totalRecords"
      ]
    },
    "listNameFormat": {
      "type": "string",
      "description": "The list name format for target ContactLists. When Custom is provided, customListNameFormatValue is required.",
      "enum": [
        "ListNamePrefix",
        "ListNamePrefixMonthDayYear",
        "ListNamePrefixMonthDayYearHourMinuteSecond",
        "ListNamePrefixPart",
        "ListNamePrefixMonthDayYearPart",
        "ListNamePrefixMonthDayYearHourMinuteSecondPart",
        "Custom"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name of the import template."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "splittingInformation": {
      "type": "object",
      "description": "Splitting Information",
      "properties": {
        "criteria": {
          "type": "string",
          "description": "The splitting criteria type",
          "enum": [
            "Percentage",
            "Quantity",
            "Column",
            "Custom"
          ]
        },
        "criteriaValue": {
          "type": "string",
          "description": "The criteria value for the specified criteria type"
        },
        "createRemainderContactList": {
          "type": "boolean",
          "description": "Whether to create remainder contact list"
        },
        "useWaterfallRule": {
          "type": "boolean",
          "description": "Whether to use waterfall rule"
        }
      }
    },
    "useSplittingCriteria": {
      "type": "boolean",
      "description": "Whether or not to use splitting criteria. Default is false."
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "importTemplateId",
    "contactListTemplate"
  ]
}

genesys-outbound_put_messagingcampaign

Update an Outbound Messaging Campaign Parameters:

Parameter	Type	Required	Default	Description
`messagingCampaignId`	string	Yes	—	The Messaging Campaign ID
`alwaysRunning`	boolean	No	—	Whether this messaging campaign is always running
`callableTimeSet`	object	No	—	Callable Time Set
`campaignStatus`	string	No	—	The current status of the messaging campaign. A messaging campaign may be turned ‘on’ or ‘off’.
`contactList`	object	Yes	—	Contact List
`contactListFilters`	object[]	No	—	The contact list filter to check before sending a message for this messaging campaign.
`contactSorts`	object[]	No	—	The order in which to sort contacts for dialing, based on up to four columns.
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`division`	object	No	—	The division value
`dncLists`	object[]	No	—	The dnc lists to check before sending a message for this messaging campaign.
`dynamicContactQueueingSettings`	object	No	—	Dynamic Contact Queueing Settings
`emailConfig`	object	No	—	Email Config
`errors`	object[]	No	—	A list of current error conditions associated with this messaging campaign.
`id`	string	No	—	The globally unique identifier for the object.
`messagesPerMinute`	integer	Yes	—	How many messages this messaging campaign will send per minute.
`name`	string	No	—	The name value
`ruleSets`	object[]	No	—	Rule Sets to be applied while this campaign is sending messages
`selfUri`	string	No	—	The URI for this object
`smsConfig`	object	No	—	Sms Config
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update
`whatsAppConfig`	object	No	—	Whats App Config

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "messagingCampaignId": {
      "type": "string",
      "description": "The Messaging Campaign ID"
    },
    "alwaysRunning": {
      "type": "boolean",
      "description": "Whether this messaging campaign is always running"
    },
    "callableTimeSet": {
      "type": "object",
      "description": "Callable Time Set",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "campaignStatus": {
      "type": "string",
      "description": "The current status of the messaging campaign. A messaging campaign may be turned 'on' or 'off'.",
      "enum": [
        "on",
        "stopping",
        "off",
        "complete",
        "invalid",
        "forced_off",
        "forced_stopping"
      ]
    },
    "contactList": {
      "type": "object",
      "description": "Contact List",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "contactListFilters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "name": {
            "type": "string",
            "description": "The name value"
          },
          "selfUri": {
            "type": "string",
            "format": "uri",
            "description": "Self Uri"
          }
        }
      },
      "description": "The contact list filter to check before sending a message for this messaging campaign."
    },
    "contactSorts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "fieldName": {
            "type": "string",
            "description": "Field Name"
          },
          "direction": {
            "type": "string",
            "enum": [
              "ASC",
              "DESC"
            ],
            "description": "The direction in which to sort contacts."
          },
          "numeric": {
            "type": "boolean",
            "description": "Whether or not the column contains numeric data."
          }
        }
      },
      "description": "The order in which to sort contacts for dialing, based on up to four columns."
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "division": {
      "type": "object",
      "description": "The division value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "dncLists": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "name": {
            "type": "string",
            "description": "The name value"
          },
          "selfUri": {
            "type": "string",
            "format": "uri",
            "description": "Self Uri"
          }
        }
      },
      "description": "The dnc lists to check before sending a message for this messaging campaign."
    },
    "dynamicContactQueueingSettings": {
      "type": "object",
      "description": "Dynamic Contact Queueing Settings",
      "properties": {
        "sort": {
          "type": "boolean",
          "description": "Whether to sort contacts dynamically"
        },
        "filter": {
          "type": "boolean",
          "description": "Whether to filter contacts dynamically"
        }
      }
    },
    "emailConfig": {
      "type": "object",
      "description": "Email Config",
      "properties": {
        "emailColumns": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The contact list columns specifying the email address(es) of the contact."
        },
        "contentTemplate": {
          "type": "object",
          "description": "Content Template"
        },
        "fromAddress": {
          "type": "object",
          "description": "From Address"
        },
        "replyToAddress": {
          "type": "object",
          "description": "Reply To Address"
        }
      },
      "required": [
        "emailColumns",
        "fromAddress"
      ]
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "description": "name of the error"
          },
          "details": {
            "type": "string",
            "description": "additional information regarding the error"
          },
          "userParams": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            },
            "description": "parameters to be inserted into details."
          }
        },
        "required": [
          "error"
        ]
      },
      "description": "A list of current error conditions associated with this messaging campaign."
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "messagesPerMinute": {
      "type": "integer",
      "description": "How many messages this messaging campaign will send per minute."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "ruleSets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "name": {
            "type": "string",
            "description": "The name value"
          },
          "selfUri": {
            "type": "string",
            "format": "uri",
            "description": "Self Uri"
          }
        }
      },
      "description": "Rule Sets to be applied while this campaign is sending messages"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "smsConfig": {
      "type": "object",
      "description": "Sms Config",
      "properties": {
        "messageColumn": {
          "type": "string",
          "description": "The Contact List column specifying the message to send to the contact."
        },
        "phoneColumn": {
          "type": "string",
          "description": "The Contact List column specifying the phone number to send a message to."
        },
        "senderSmsPhoneNumber": {
          "type": "object",
          "description": "Sender Sms Phone Number"
        },
        "contentTemplate": {
          "type": "object",
          "description": "Content Template"
        }
      },
      "required": [
        "messageColumn",
        "phoneColumn",
        "senderSmsPhoneNumber"
      ]
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    },
    "whatsAppConfig": {
      "type": "object",
      "description": "Whats App Config",
      "properties": {
        "whatsAppColumns": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The contact list columns specifying the WhatsApp address(es) of the contact."
        },
        "whatsAppIntegration": {
          "type": "object",
          "description": "Whats App Integration"
        },
        "contentTemplate": {
          "type": "object",
          "description": "Content Template"
        }
      },
      "required": [
        "contentTemplate",
        "whatsAppColumns",
        "whatsAppIntegration"
      ]
    }
  },
  "required": [
    "PCID",
    "messagingCampaignId",
    "contactList",
    "messagesPerMinute"
  ]
}

genesys-outbound_put_ruleset

Update a Rule Set. Parameters:

Parameter	Type	Required	Default	Description
`ruleSetId`	string	Yes	—	Rule Set ID
`contactList`	object	No	—	Contact List
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`id`	string	No	—	The globally unique identifier for the object.
`name`	string	Yes	—	The name of the RuleSet.
`queue`	object	No	—	The queue value
`rules`	object[]	Yes	—	The list of rules.
`selfUri`	string	No	—	The URI for this object
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ruleSetId": {
      "type": "string",
      "description": "Rule Set ID"
    },
    "contactList": {
      "type": "object",
      "description": "Contact List",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "name": {
      "type": "string",
      "description": "The name of the RuleSet."
    },
    "queue": {
      "type": "object",
      "description": "The queue value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "rules": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The identifier of the rule."
          },
          "name": {
            "type": "string",
            "description": "The name of the rule."
          },
          "order": {
            "type": "integer",
            "format": "int32",
            "description": "The ranked order of the rule. Rules are processed from lowest number to highest."
          },
          "category": {
            "type": "string",
            "enum": [
              "DIALER_PRECALL",
              "DIALER_WRAPUP"
            ],
            "description": "The category of the rule."
          },
          "conditions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "description": "The type of the condition."
                },
                "inverted": {
                  "type": "boolean",
                  "description": "If true, inverts the result of evaluating this Condition. Default is false."
                },
                "attributeName": {
                  "type": "string",
                  "description": "An attribute name associated with this Condition. Required for a contactAttributeCondition."
                },
                "value": {
                  "type": "string",
                  "description": "A value associated with this Condition. This could be text, a number, or a relative time. Not used for a DataActionCondition."
                },
                "valueType": {
                  "type": "string",
                  "description": "The type of the value associated with this Condition. Not used for a DataActionCondition."
                },
                "operator": {
                  "type": "string",
                  "description": "An operation with which to evaluate the Condition. Not used for a DataActionCondition."
                },
                "codes": {
                  "type": "array",
                  "description": "List of wrap-up code identifiers. Required for a wrapupCondition."
                },
                "property": {
                  "type": "string",
                  "description": "A value associated with the property type of this Condition. Required for a contactPropertyCondition."
                },
                "propertyType": {
                  "type": "string",
                  "description": "The type of the property associated with this Condition. Required for a contactPropertyCondition."
                },
                "dataAction": {
                  "type": "object"
                },
                "dataNotFoundResolution": {
                  "type": "boolean",
                  "description": "The result of this condition if the data action returns a result indicating there was no data. Required for a DataActionCondition."
                },
                "contactIdField": {
                  "type": "string",
                  "description": "The input field from the data action that the contactId will be passed to for this condition. Valid for a dataActionCondition."
                },
                "callAnalysisResultField": {
                  "type": "string",
                  "description": "The input field from the data action that the callAnalysisResult will be passed to for this condition. Valid for a wrapup dataActionCondition."
                },
                "agentWrapupField": {
                  "type": "string",
                  "description": "The input field from the data action that the agentWrapup will be passed to for this condition. Valid for a wrapup dataActionCondition."
                },
                "contactColumnToDataActionFieldMappings": {
                  "type": "array",
                  "description": "A list of mappings defining which contact data fields will be passed to which data action input fields for this condition. Valid for a dataActionCondition."
                },
                "predicates": {
                  "type": "array",
                  "description": "A list of predicates defining the comparisons to use for this condition. Required for a dataActionCondition."
                },
                "subConditions": {
                  "type": "array",
                  "description": "A list of sub-conditions to evaluate. Required for a timeAndDateCondition."
                },
                "matchAnyConditions": {
                  "type": "boolean",
                  "description": "If true, only one sub-condition must match for the condition to be true. If false, all sub-conditions must match. Default is false. Required for a timeAndDateCondition."
                },
                "timeZoneId": {
                  "type": "string",
                  "description": "The time zone to use for this condition. Required for a timeAndDateCondition."
                }
              }
            },
            "description": "A list of Conditions. All of the Conditions must evaluate to true to trigger the actions."
          },
          "actions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "description": "The type of this DialerAction."
                },
                "actionTypeName": {
                  "type": "string",
                  "description": "Additional type specification for this DialerAction."
                },
                "updateOption": {
                  "type": "string",
                  "description": "Specifies how a contact attribute should be updated. Required for MODIFY_CONTACT_ATTRIBUTE."
                },
                "properties": {
                  "type": "object",
                  "description": "A map of key-value pairs pertinent to the DialerAction. Different types of DialerActions require different properties. MODIFY_CONTACT_ATTRIBUTE with an updateOption of SET takes a contact column as the key and accepts any value. SCHEDULE_CALLBACK takes a key 'callbackOffset' that specifies how far in the future the callback should be scheduled, in minutes. SET_CALLER_ID takes two keys: 'callerAddress', which should be the caller id phone number, and 'callerName'. For either key, you can also specify a column on the contact to get the value from. To do this, specify 'contact.Column', where 'Column' is the name of the contact column from which to get the value. SET_SKILLS takes a key 'skills' with an array of skill ids wrapped into a string (Example: {'skills': '['skillIdHere']'} )."
                },
                "dataAction": {
                  "type": "object"
                },
                "contactColumnToDataActionFieldMappings": {
                  "type": "array",
                  "description": "A list of mappings defining which contact data fields will be passed to which data action input fields for this condition. Valid for a dataActionBehavior."
                },
                "contactIdField": {
                  "type": "string",
                  "description": "The input field from the data action that the contactId will be passed to for this condition. Valid for a dataActionBehavior."
                },
                "callAnalysisResultField": {
                  "type": "string",
                  "description": "The input field from the data action that the callAnalysisResult will be passed to for this condition. Valid for a wrapup dataActionBehavior."
                },
                "agentWrapupField": {
                  "type": "string",
                  "description": "The input field from the data action that the agentWrapup will be passed to for this condition. Valid for a wrapup dataActionBehavior."
                }
              }
            },
            "description": "The list of actions to be taken if the conditions are true."
          }
        },
        "required": [
          "category",
          "conditions",
          "name"
        ]
      },
      "description": "The list of rules."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "ruleSetId",
    "name",
    "rules"
  ]
}

genesys-outbound_put_schedules_campaign

Update a new campaign schedule. Parameters:

Parameter	Type	Required	Default	Description
`campaignId`	string	Yes	—	Campaign ID
`campaign`	object	Yes	—	The campaign value
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`id`	string	No	—	The globally unique identifier for the object.
`intervals`	object[]	Yes	—	A list of intervals during which to run the associated Campaign.
`name`	string	No	—	The name value
`recurrences`	object[]	No	—	Recurring schedules of the campaign
`selfUri`	string	No	—	The URI for this object
`timeZone`	string	No	—	The time zone for this CampaignSchedule. Defaults to UTC if empty or not provided. See here for a list of valid time zones https://www.iana.org/time-zones. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaignId": {
      "type": "string",
      "description": "Campaign ID"
    },
    "campaign": {
      "type": "object",
      "description": "The campaign value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        },
        "division": {
          "type": "object",
          "description": "The division value"
        }
      }
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "intervals": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "start": {
            "type": "string",
            "description": "The scheduled start time as an ISO-8601 string, i.e yyyy-MM-ddTHH:mm:ss.SSSZ"
          },
          "end": {
            "type": "string",
            "description": "The scheduled end time as an ISO-8601 string, i.e. yyyy-MM-ddTHH:mm:ss.SSSZ"
          }
        },
        "required": [
          "end",
          "start"
        ]
      },
      "description": "A list of intervals during which to run the associated Campaign."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "recurrences": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "start": {
            "type": "string",
            "description": "The start date time of the initial occurrence as an ISO-8601 string in the format YYYY-MM-DDThh:mm:ss"
          },
          "end": {
            "type": "string",
            "description": "The end date time of the initial occurrence as an ISO-8601 string in the format YYYY-MM-DDThh:mm:ss"
          },
          "timeZone": {
            "type": "string",
            "description": "The time zone for the recurrence. The time zone of the recurrence is determined by prioritizing the recurrence's time zone if specified, then the schedule's time zone if set, and finally defaulting to UTC if neither defines a time zone. See here for a list of valid time zones https://www.iana.org/time-zones. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
          },
          "pattern": {
            "type": "object",
            "description": "The pattern value"
          },
          "range": {
            "type": "object",
            "description": "The range value"
          },
          "alterations": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "description": "Range type (Exclusion: used to exclude a specific time within the recurrence. Inclusion: used to include a specific time within the recurrence which will execute in addition to the normal recurrence. If both an exclusion and inclusion are specified, the inclusion will take precedence over the exclusion.)"
                },
                "start": {
                  "type": "string",
                  "description": "The start date of an alteration range as an ISO-8601 string"
                },
                "end": {
                  "type": "string",
                  "description": "The end date of an alteration range as an ISO-8601 string"
                }
              }
            },
            "description": "Modifications to the original recurrence schedule (Exclusions/Inclusions)"
          },
          "nextOccurrenceDetails": {
            "type": "object",
            "description": "Next Occurrence Details"
          }
        },
        "required": [
          "end",
          "pattern",
          "range",
          "start"
        ]
      },
      "description": "Recurring schedules of the campaign"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "timeZone": {
      "type": "string",
      "description": "The time zone for this CampaignSchedule. Defaults to UTC if empty or not provided. See here for a list of valid time zones https://www.iana.org/time-zones. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "campaignId",
    "campaign",
    "intervals"
  ]
}

genesys-outbound_put_schedules_emailcampaign

Update an email campaign schedule. Parameters:

Parameter	Type	Required	Default	Description
`emailCampaignId`	string	Yes	—	Email Campaign ID
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`emailCampaign`	object	Yes	—	Email Campaign
`id`	string	No	—	The globally unique identifier for the object.
`intervals`	object[]	Yes	—	A list of intervals during which to run the associated Campaign.
`name`	string	No	—	The name value
`recurrences`	object[]	No	—	Recurring schedules of the campaign
`selfUri`	string	No	—	The URI for this object
`timeZone`	string	No	—	The time zone for this email campaign schedule. Defaults to UTC if empty or not provided. See here for a list of valid time zones https://www.iana.org/time-zones. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "emailCampaignId": {
      "type": "string",
      "description": "Email Campaign ID"
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "emailCampaign": {
      "type": "object",
      "description": "Email Campaign",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        },
        "division": {
          "type": "object",
          "description": "The division value"
        }
      }
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "intervals": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "start": {
            "type": "string",
            "description": "The scheduled start time as an ISO-8601 string, i.e yyyy-MM-ddTHH:mm:ss.SSSZ"
          },
          "end": {
            "type": "string",
            "description": "The scheduled end time as an ISO-8601 string, i.e. yyyy-MM-ddTHH:mm:ss.SSSZ"
          }
        },
        "required": [
          "end",
          "start"
        ]
      },
      "description": "A list of intervals during which to run the associated Campaign."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "recurrences": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "start": {
            "type": "string",
            "description": "The start date time of the initial occurrence as an ISO-8601 string in the format YYYY-MM-DDThh:mm:ss"
          },
          "end": {
            "type": "string",
            "description": "The end date time of the initial occurrence as an ISO-8601 string in the format YYYY-MM-DDThh:mm:ss"
          },
          "timeZone": {
            "type": "string",
            "description": "The time zone for the recurrence. The time zone of the recurrence is determined by prioritizing the recurrence's time zone if specified, then the schedule's time zone if set, and finally defaulting to UTC if neither defines a time zone. See here for a list of valid time zones https://www.iana.org/time-zones. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
          },
          "pattern": {
            "type": "object",
            "description": "The pattern value"
          },
          "range": {
            "type": "object",
            "description": "The range value"
          },
          "alterations": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "description": "Range type (Exclusion: used to exclude a specific time within the recurrence. Inclusion: used to include a specific time within the recurrence which will execute in addition to the normal recurrence. If both an exclusion and inclusion are specified, the inclusion will take precedence over the exclusion.)"
                },
                "start": {
                  "type": "string",
                  "description": "The start date of an alteration range as an ISO-8601 string"
                },
                "end": {
                  "type": "string",
                  "description": "The end date of an alteration range as an ISO-8601 string"
                }
              }
            },
            "description": "Modifications to the original recurrence schedule (Exclusions/Inclusions)"
          },
          "nextOccurrenceDetails": {
            "type": "object",
            "description": "Next Occurrence Details"
          }
        },
        "required": [
          "end",
          "pattern",
          "range",
          "start"
        ]
      },
      "description": "Recurring schedules of the campaign"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "timeZone": {
      "type": "string",
      "description": "The time zone for this email campaign schedule. Defaults to UTC if empty or not provided. See here for a list of valid time zones https://www.iana.org/time-zones. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "emailCampaignId",
    "emailCampaign",
    "intervals"
  ]
}

genesys-outbound_put_schedules_messagingcampaign

Update a new messaging campaign schedule. Parameters:

Parameter	Type	Required	Default	Description
`messagingCampaignId`	string	Yes	—	Messaging Campaign ID
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`id`	string	No	—	The globally unique identifier for the object.
`intervals`	object[]	Yes	—	A list of intervals during which to run the associated Campaign.
`messagingCampaign`	object	Yes	—	Messaging Campaign
`name`	string	No	—	The name value
`recurrences`	object[]	No	—	Recurring schedules of the campaign
`selfUri`	string	No	—	The URI for this object
`timeZone`	string	No	—	The time zone for this messaging campaign schedule. Defaults to UTC if empty or not provided. See here for a list of valid time zones https://www.iana.org/time-zones. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "messagingCampaignId": {
      "type": "string",
      "description": "Messaging Campaign ID"
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "intervals": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "start": {
            "type": "string",
            "description": "The scheduled start time as an ISO-8601 string, i.e yyyy-MM-ddTHH:mm:ss.SSSZ"
          },
          "end": {
            "type": "string",
            "description": "The scheduled end time as an ISO-8601 string, i.e. yyyy-MM-ddTHH:mm:ss.SSSZ"
          }
        },
        "required": [
          "end",
          "start"
        ]
      },
      "description": "A list of intervals during which to run the associated Campaign."
    },
    "messagingCampaign": {
      "type": "object",
      "description": "Messaging Campaign",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        },
        "division": {
          "type": "object",
          "description": "The division value"
        }
      }
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "recurrences": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "start": {
            "type": "string",
            "description": "The start date time of the initial occurrence as an ISO-8601 string in the format YYYY-MM-DDThh:mm:ss"
          },
          "end": {
            "type": "string",
            "description": "The end date time of the initial occurrence as an ISO-8601 string in the format YYYY-MM-DDThh:mm:ss"
          },
          "timeZone": {
            "type": "string",
            "description": "The time zone for the recurrence. The time zone of the recurrence is determined by prioritizing the recurrence's time zone if specified, then the schedule's time zone if set, and finally defaulting to UTC if neither defines a time zone. See here for a list of valid time zones https://www.iana.org/time-zones. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
          },
          "pattern": {
            "type": "object",
            "description": "The pattern value"
          },
          "range": {
            "type": "object",
            "description": "The range value"
          },
          "alterations": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "description": "Range type (Exclusion: used to exclude a specific time within the recurrence. Inclusion: used to include a specific time within the recurrence which will execute in addition to the normal recurrence. If both an exclusion and inclusion are specified, the inclusion will take precedence over the exclusion.)"
                },
                "start": {
                  "type": "string",
                  "description": "The start date of an alteration range as an ISO-8601 string"
                },
                "end": {
                  "type": "string",
                  "description": "The end date of an alteration range as an ISO-8601 string"
                }
              }
            },
            "description": "Modifications to the original recurrence schedule (Exclusions/Inclusions)"
          },
          "nextOccurrenceDetails": {
            "type": "object",
            "description": "Next Occurrence Details"
          }
        },
        "required": [
          "end",
          "pattern",
          "range",
          "start"
        ]
      },
      "description": "Recurring schedules of the campaign"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "timeZone": {
      "type": "string",
      "description": "The time zone for this messaging campaign schedule. Defaults to UTC if empty or not provided. See here for a list of valid time zones https://www.iana.org/time-zones. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "messagingCampaignId",
    "intervals",
    "messagingCampaign"
  ]
}

genesys-outbound_put_schedules_sequence

Update a new sequence schedule. Parameters:

Parameter	Type	Required	Default	Description
`sequenceId`	string	Yes	—	Sequence ID
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`id`	string	No	—	The globally unique identifier for the object.
`intervals`	object[]	Yes	—	A list of intervals during which to run the associated CampaignSequence.
`name`	string	No	—	The name value
`recurrences`	object[]	No	—	Recurring schedules of the campaign
`selfUri`	string	No	—	The URI for this object
`sequence`	object	Yes	—	The sequence value
`timeZone`	string	No	—	The time zone for this SequenceSchedule. Defaults to UTC if empty or not provided. See here for a list of valid time zones https://www.iana.org/time-zones. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sequenceId": {
      "type": "string",
      "description": "Sequence ID"
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "intervals": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "start": {
            "type": "string",
            "description": "The scheduled start time as an ISO-8601 string, i.e yyyy-MM-ddTHH:mm:ss.SSSZ"
          },
          "end": {
            "type": "string",
            "description": "The scheduled end time as an ISO-8601 string, i.e. yyyy-MM-ddTHH:mm:ss.SSSZ"
          }
        },
        "required": [
          "end",
          "start"
        ]
      },
      "description": "A list of intervals during which to run the associated CampaignSequence."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "recurrences": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "start": {
            "type": "string",
            "description": "The start date time of the initial occurrence as an ISO-8601 string in the format YYYY-MM-DDThh:mm:ss"
          },
          "end": {
            "type": "string",
            "description": "The end date time of the initial occurrence as an ISO-8601 string in the format YYYY-MM-DDThh:mm:ss"
          },
          "timeZone": {
            "type": "string",
            "description": "The time zone for the recurrence. The time zone of the recurrence is determined by prioritizing the recurrence's time zone if specified, then the schedule's time zone if set, and finally defaulting to UTC if neither defines a time zone. See here for a list of valid time zones https://www.iana.org/time-zones. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
          },
          "pattern": {
            "type": "object",
            "description": "The pattern value"
          },
          "range": {
            "type": "object",
            "description": "The range value"
          },
          "alterations": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "description": "Range type (Exclusion: used to exclude a specific time within the recurrence. Inclusion: used to include a specific time within the recurrence which will execute in addition to the normal recurrence. If both an exclusion and inclusion are specified, the inclusion will take precedence over the exclusion.)"
                },
                "start": {
                  "type": "string",
                  "description": "The start date of an alteration range as an ISO-8601 string"
                },
                "end": {
                  "type": "string",
                  "description": "The end date of an alteration range as an ISO-8601 string"
                }
              }
            },
            "description": "Modifications to the original recurrence schedule (Exclusions/Inclusions)"
          },
          "nextOccurrenceDetails": {
            "type": "object",
            "description": "Next Occurrence Details"
          }
        },
        "required": [
          "end",
          "pattern",
          "range",
          "start"
        ]
      },
      "description": "Recurring schedules of the campaign"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "sequence": {
      "type": "object",
      "description": "The sequence value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    },
    "timeZone": {
      "type": "string",
      "description": "The time zone for this SequenceSchedule. Defaults to UTC if empty or not provided. See here for a list of valid time zones https://www.iana.org/time-zones. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "sequenceId",
    "intervals",
    "sequence"
  ]
}

genesys-outbound_put_schedules_whatsappcampaign

Update a WhatsApp campaign schedule. Parameters:

Parameter	Type	Required	Default	Description
`whatsAppCampaignId`	string	Yes	—	WhatsApp Campaign ID
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`id`	string	No	—	The globally unique identifier for the object.
`intervals`	object[]	Yes	—	A list of intervals during which to run the associated Campaign.
`name`	string	No	—	The name value
`recurrences`	object[]	No	—	Recurring schedules of the campaign
`selfUri`	string	No	—	The URI for this object
`timeZone`	string	No	—	The time zone for this WhatsApp campaign schedule. Defaults to UTC if empty or not provided. See here for a list of valid time zones https://www.iana.org/time-zones. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update
`whatsAppCampaign`	object	Yes	—	Whats App Campaign

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "whatsAppCampaignId": {
      "type": "string",
      "description": "WhatsApp Campaign ID"
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "intervals": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "start": {
            "type": "string",
            "description": "The scheduled start time as an ISO-8601 string, i.e yyyy-MM-ddTHH:mm:ss.SSSZ"
          },
          "end": {
            "type": "string",
            "description": "The scheduled end time as an ISO-8601 string, i.e. yyyy-MM-ddTHH:mm:ss.SSSZ"
          }
        },
        "required": [
          "end",
          "start"
        ]
      },
      "description": "A list of intervals during which to run the associated Campaign."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "recurrences": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "start": {
            "type": "string",
            "description": "The start date time of the initial occurrence as an ISO-8601 string in the format YYYY-MM-DDThh:mm:ss"
          },
          "end": {
            "type": "string",
            "description": "The end date time of the initial occurrence as an ISO-8601 string in the format YYYY-MM-DDThh:mm:ss"
          },
          "timeZone": {
            "type": "string",
            "description": "The time zone for the recurrence. The time zone of the recurrence is determined by prioritizing the recurrence's time zone if specified, then the schedule's time zone if set, and finally defaulting to UTC if neither defines a time zone. See here for a list of valid time zones https://www.iana.org/time-zones. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
          },
          "pattern": {
            "type": "object",
            "description": "The pattern value"
          },
          "range": {
            "type": "object",
            "description": "The range value"
          },
          "alterations": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "description": "Range type (Exclusion: used to exclude a specific time within the recurrence. Inclusion: used to include a specific time within the recurrence which will execute in addition to the normal recurrence. If both an exclusion and inclusion are specified, the inclusion will take precedence over the exclusion.)"
                },
                "start": {
                  "type": "string",
                  "description": "The start date of an alteration range as an ISO-8601 string"
                },
                "end": {
                  "type": "string",
                  "description": "The end date of an alteration range as an ISO-8601 string"
                }
              }
            },
            "description": "Modifications to the original recurrence schedule (Exclusions/Inclusions)"
          },
          "nextOccurrenceDetails": {
            "type": "object",
            "description": "Next Occurrence Details"
          }
        },
        "required": [
          "end",
          "pattern",
          "range",
          "start"
        ]
      },
      "description": "Recurring schedules of the campaign"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "timeZone": {
      "type": "string",
      "description": "The time zone for this WhatsApp campaign schedule. Defaults to UTC if empty or not provided. See here for a list of valid time zones https://www.iana.org/time-zones. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    },
    "whatsAppCampaign": {
      "type": "object",
      "description": "Whats App Campaign",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        },
        "division": {
          "type": "object",
          "description": "The division value"
        }
      }
    }
  },
  "required": [
    "PCID",
    "whatsAppCampaignId",
    "intervals",
    "whatsAppCampaign"
  ]
}

genesys-outbound_put_sequence

Update a new campaign sequence. Parameters:

Parameter	Type	Required	Default	Description
`sequenceId`	string	Yes	—	Campaign Sequence ID
`campaigns`	object[]	Yes	—	The ordered list of Campaigns that this CampaignSequence will run.
`currentCampaign`	integer	Yes	—	A zero-based index indicating which Campaign this CampaignSequence is currently on.
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`id`	string	No	—	The globally unique identifier for the object.
`name`	string	No	—	The name value
`repeat`	boolean	No	—	Indicates if a sequence should repeat from the beginning after the last campaign completes. Default is false.
`selfUri`	string	No	—	The URI for this object
`status`	string	Yes	—	The current status of the CampaignSequence. A CampaignSequence can be turned ‘on’ or ‘off’.
`stopMessage`	string	No	—	A message indicating if and why a CampaignSequence has stopped unexpectedly.
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sequenceId": {
      "type": "string",
      "description": "Campaign Sequence ID"
    },
    "campaigns": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "name": {
            "type": "string",
            "description": "The name value"
          },
          "selfUri": {
            "type": "string",
            "format": "uri",
            "description": "Self Uri"
          }
        }
      },
      "description": "The ordered list of Campaigns that this CampaignSequence will run."
    },
    "currentCampaign": {
      "type": "integer",
      "description": "A zero-based index indicating which Campaign this CampaignSequence is currently on."
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "repeat": {
      "type": "boolean",
      "description": "Indicates if a sequence should repeat from the beginning after the last campaign completes. Default is false."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "status": {
      "type": "string",
      "description": "The current status of the CampaignSequence. A CampaignSequence can be turned 'on' or 'off'.",
      "enum": [
        "on",
        "off",
        "complete"
      ]
    },
    "stopMessage": {
      "type": "string",
      "description": "A message indicating if and why a CampaignSequence has stopped unexpectedly."
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID",
    "sequenceId",
    "campaigns",
    "currentCampaign",
    "status"
  ]
}

genesys-outbound_put_wrapupcodemappings

Update the Dialer wrap up code mapping. Parameters:

Parameter	Type	Required	Default	Description
`dateCreated`	string	No	—	Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`defaultSet`	string[]	No	—	The default set of wrap-up flags. These will be used if there is no entry for a given wrap-up code in the mapping.
`id`	string	No	—	The globally unique identifier for the object.
`mapping`	object	No	—	A map from wrap-up code identifiers to a set of wrap-up flags.
`name`	string	No	—	The name value
`selfUri`	string	No	—	The URI for this object
`entityVersion`	integer	No	—	Required for updates, must match the version number of the most recent update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dateCreated": {
      "type": "string",
      "description": "Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "defaultSet": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "CONTACT_UNCALLABLE",
          "NUMBER_UNCALLABLE",
          "RIGHT_PARTY_CONTACT",
          "BUSINESS_SUCCESS",
          "BUSINESS_FAILURE",
          "BUSINESS_NEUTRAL"
        ]
      },
      "description": "The default set of wrap-up flags. These will be used if there is no entry for a given wrap-up code in the mapping."
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "mapping": {
      "type": "object",
      "description": "A map from wrap-up code identifiers to a set of wrap-up flags."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "entityVersion": {
      "type": "integer",
      "description": "Required for updates, must match the version number of the most recent update"
    }
  },
  "required": [
    "PCID"
  ]
}

​Tools

​genesys-outbound_delete_attemptlimit

​genesys-outbound_delete_callabletimeset

​genesys-outbound_delete_callanalysisresponseset

​genesys-outbound_delete_campaign

​genesys-outbound_delete_campaign_progress

​genesys-outbound_delete_campaignrule

​genesys-outbound_delete_contactlist

​genesys-outbound_delete_contactlist_contact

​genesys-outbound_delete_contactlist_contacts

​genesys-outbound_delete_contactlistfilter

​genesys-outbound_delete_contactlists

​genesys-outbound_delete_contactlisttemplate

​genesys-outbound_delete_contactlisttemplates

​genesys-outbound_delete_digitalruleset

​genesys-outbound_delete_dnclist

​genesys-outbound_delete_dnclist_customexclusioncolumns

​genesys-outbound_delete_dnclist_emailaddresses

​genesys-outbound_delete_dnclist_phonenumbers

​genesys-outbound_delete_dnclist_whatsappnumbers

​genesys-outbound_delete_filespecificationtemplate

​genesys-outbound_delete_filespecificationtemplates_bulk

​genesys-outbound_delete_importtemplate

​genesys-outbound_delete_importtemplates

​genesys-outbound_delete_messagingcampaign

​genesys-outbound_delete_messagingcampaign_progress

​genesys-outbound_delete_ruleset

​genesys-outbound_delete_schedules_campaign

​genesys-outbound_delete_schedules_emailcampaign

​genesys-outbound_delete_schedules_messagingcampaign

​genesys-outbound_delete_schedules_sequence

​genesys-outbound_delete_schedules_whatsappcampaign

​genesys-outbound_delete_sequence

​genesys-outbound_get_attemptlimit

​genesys-outbound_get_attemptlimits

​genesys-outbound_get_callabletimeset

​genesys-outbound_get_callabletimesets

​genesys-outbound_get_callanalysisresponseset

​genesys-outbound_get_callanalysisresponsesets

​genesys-outbound_get_campaign

​genesys-outbound_get_campaign_agentownedmappingpreview_results

​genesys-outbound_get_campaign_diagnostics

​genesys-outbound_get_campaign_interactions

​genesys-outbound_get_campaign_linedistribution

​genesys-outbound_get_campaign_progress

​genesys-outbound_get_campaign_skillcombinations

​genesys-outbound_get_campaign_stats

​genesys-outbound_get_campaignrule

​genesys-outbound_get_campaignrules

​genesys-outbound_get_campaigns

​genesys-outbound_get_campaigns_all

​genesys-outbound_get_campaigns_all_divisionviews

​genesys-outbound_get_campaigns_divisionview

​genesys-outbound_get_campaigns_divisionviews

​genesys-outbound_get_contactlist

​genesys-outbound_get_contactlist_contact

​genesys-outbound_get_contactlist_contacts_bulk_job

​genesys-outbound_get_contactlist_contacts_bulk_jobs

​genesys-outbound_get_contactlist_export

​genesys-outbound_get_contactlist_importstatus

​genesys-outbound_get_contactlist_timezonemappingpreview

​genesys-outbound_get_contactlistfilter

​genesys-outbound_get_contactlistfilters

​genesys-outbound_get_contactlists

​genesys-outbound_get_contactlists_divisionview

​genesys-outbound_get_contactlists_divisionviews

​genesys-outbound_get_contactlisttemplate

​genesys-outbound_get_contactlisttemplates

​genesys-outbound_get_diagnostics_campaign_summary

​genesys-outbound_get_digitalruleset

​genesys-outbound_get_digitalrulesets

​genesys-outbound_get_dnclist

​genesys-outbound_get_dnclist_export

​genesys-outbound_get_dnclist_importstatus

​genesys-outbound_get_dnclists

​genesys-outbound_get_dnclists_divisionview

​genesys-outbound_get_dnclists_divisionviews

​genesys-outbound_get_event

​genesys-outbound_get_events

​genesys-outbound_get_filespecificationtemplate

Tools

genesys-outbound_delete_attemptlimit

genesys-outbound_delete_callabletimeset

genesys-outbound_delete_callanalysisresponseset

genesys-outbound_delete_campaign

genesys-outbound_delete_campaign_progress

genesys-outbound_delete_campaignrule

genesys-outbound_delete_contactlist

genesys-outbound_delete_contactlist_contact

genesys-outbound_delete_contactlist_contacts

genesys-outbound_delete_contactlistfilter

genesys-outbound_delete_contactlists

genesys-outbound_delete_contactlisttemplate

genesys-outbound_delete_contactlisttemplates

genesys-outbound_delete_digitalruleset

genesys-outbound_delete_dnclist

genesys-outbound_delete_dnclist_customexclusioncolumns

genesys-outbound_delete_dnclist_emailaddresses

genesys-outbound_delete_dnclist_phonenumbers

genesys-outbound_delete_dnclist_whatsappnumbers

genesys-outbound_delete_filespecificationtemplate

genesys-outbound_delete_filespecificationtemplates_bulk

genesys-outbound_delete_importtemplate

genesys-outbound_delete_importtemplates

genesys-outbound_delete_messagingcampaign

genesys-outbound_delete_messagingcampaign_progress

genesys-outbound_delete_ruleset

genesys-outbound_delete_schedules_campaign

genesys-outbound_delete_schedules_emailcampaign

genesys-outbound_delete_schedules_messagingcampaign

genesys-outbound_delete_schedules_sequence

genesys-outbound_delete_schedules_whatsappcampaign

genesys-outbound_delete_sequence

genesys-outbound_get_attemptlimit

genesys-outbound_get_attemptlimits

genesys-outbound_get_callabletimeset

genesys-outbound_get_callabletimesets

genesys-outbound_get_callanalysisresponseset

genesys-outbound_get_callanalysisresponsesets

genesys-outbound_get_campaign

genesys-outbound_get_campaign_agentownedmappingpreview_results

genesys-outbound_get_campaign_diagnostics

genesys-outbound_get_campaign_interactions

genesys-outbound_get_campaign_linedistribution

genesys-outbound_get_campaign_progress

genesys-outbound_get_campaign_skillcombinations

genesys-outbound_get_campaign_stats

genesys-outbound_get_campaignrule

genesys-outbound_get_campaignrules

genesys-outbound_get_campaigns

genesys-outbound_get_campaigns_all

genesys-outbound_get_campaigns_all_divisionviews

genesys-outbound_get_campaigns_divisionview

genesys-outbound_get_campaigns_divisionviews

genesys-outbound_get_contactlist

genesys-outbound_get_contactlist_contact

genesys-outbound_get_contactlist_contacts_bulk_job

genesys-outbound_get_contactlist_contacts_bulk_jobs

genesys-outbound_get_contactlist_export

genesys-outbound_get_contactlist_importstatus

genesys-outbound_get_contactlist_timezonemappingpreview

genesys-outbound_get_contactlistfilter

genesys-outbound_get_contactlistfilters

genesys-outbound_get_contactlists

genesys-outbound_get_contactlists_divisionview

genesys-outbound_get_contactlists_divisionviews

genesys-outbound_get_contactlisttemplate

genesys-outbound_get_contactlisttemplates

genesys-outbound_get_diagnostics_campaign_summary

genesys-outbound_get_digitalruleset

genesys-outbound_get_digitalrulesets

genesys-outbound_get_dnclist

genesys-outbound_get_dnclist_export

genesys-outbound_get_dnclist_importstatus

genesys-outbound_get_dnclists

genesys-outbound_get_dnclists_divisionview

genesys-outbound_get_dnclists_divisionviews

genesys-outbound_get_event

genesys-outbound_get_events

genesys-outbound_get_filespecificationtemplate