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

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

Tools

Tool	Description
`genesys_journey_delete_actionmap`	Delete single action map.
`genesys_journey_delete_actiontemplate`	Delete a single action template.
`genesys_journey_delete_outcome`	Delete an outcome.
`genesys_journey_delete_outcomes_predictor`	Delete an outcome predictor.
`genesys_journey_delete_segment`	Delete a segment.
`genesys_journey_delete_view`	Delete a Journey View by ID
`genesys_journey_delete_view_schedules`	Delete the Schedule of a JourneyView
`genesys_journey_get_actionmap`	Retrieve a single action map.
`genesys_journey_get_actionmaps`	Retrieve all action maps.
`genesys_journey_get_actionmaps_estimates_job`	Get status of job.
`genesys_journey_get_actionmaps_estimates_job_results`	Get estimates from completed job.
`genesys_journey_get_actiontarget`	Retrieve a single action target.
`genesys_journey_get_actiontargets`	Retrieve all action targets.
`genesys_journey_get_actiontemplate`	Retrieve a single action template.
`genesys_journey_get_actiontemplates`	Retrieve all action templates.
`genesys_journey_get_deployment_customer_ping`	Send a ping.
`genesys_journey_get_outcome`	Retrieve a single outcome.
`genesys_journey_get_outcomes`	Retrieve all outcomes.
`genesys_journey_get_outcomes_predictor`	Retrieve a single outcome predictor.
`genesys_journey_get_outcomes_predictors`	Retrieve all outcome predictors.
`genesys_journey_get_segment`	Retrieve a single segment.
`genesys_journey_get_segments`	Retrieve all segments.
`genesys_journey_get_session`	Retrieve a single session.
`genesys_journey_get_session_events`	Retrieve all events for a given session.
`genesys_journey_get_session_outcomescores`	Retrieve latest outcome score associated with a session for all outcomes.
`genesys_journey_get_view`	Get a Journey View by ID
`genesys_journey_get_view_schedules`	Get the Schedule for a JourneyView
`genesys_journey_get_view_version`	Get a Journey View by ID and version
`genesys_journey_get_view_version_chart`	Get a Chart by ID
`genesys_journey_get_view_version_chart_version`	Get a Chart by ID and version
`genesys_journey_get_view_version_job`	Get the job for a journey view version.
`genesys_journey_get_view_version_job_results`	Get the result of a job for a journey view version.
`genesys_journey_get_view_version_job_results_chart`	Get the chart result associated with a journey view job.
`genesys_journey_get_view_version_jobs_latest`	Get the latest job of a journey view version.
`genesys_journey_get_views`	Get a list of Journey Views
`genesys_journey_get_views_data_details`	Get details about the data available for journey queries including oldest and newest event dates
`genesys_journey_get_views_eventdefinition`	Get an Event Definition
`genesys_journey_get_views_eventdefinitions`	Get a list of Event Definitions
`genesys_journey_get_views_jobs`	Get the jobs for an organization.
`genesys_journey_get_views_jobs_me`	Get my jobs
`genesys_journey_get_views_schedules`	Get the journey schedules for an organization.
`genesys_journey_patch_actionmap`	Update single action map.
`genesys_journey_patch_actiontarget`	Update a single action target.
`genesys_journey_patch_actiontemplate`	Update a single action template.
`genesys_journey_patch_outcome`	Update an outcome.
`genesys_journey_patch_segment`	Update a segment.
`genesys_journey_patch_view_version_job`	Update the job for a journey view version. Only the status can be changed and only to Cancelled
`genesys_journey_post_actionmaps`	Create an action map.
`genesys_journey_post_actionmaps_estimates_jobs`	Query for estimates
`genesys_journey_post_actiontemplates`	Create a single action template.
`genesys_journey_post_deployment_actionevent`	Sends an action event, which is used for changing the state of actions that have been offered to the user.
`genesys_journey_post_deployment_appevents`	Send a journey app event, used for tracking customer activity on an application.
`genesys_journey_post_deployment_webevents`	Send a journey web event, used for tracking customer activity on a website.
`genesys_journey_post_flows_paths_query`	Query for flow paths.
`genesys_journey_post_outcomes`	Create an outcome.
`genesys_journey_post_outcomes_predictors`	Create an outcome predictor.
`genesys_journey_post_segments`	Create a segment.
`genesys_journey_post_view_schedules`	Add a new Schedule to a JourneyView
`genesys_journey_post_view_version_jobs`	Submit a job request for a journey view version.
`genesys_journey_post_view_versions`	Update a Journey View by ID
`genesys_journey_post_views`	Create a new Journey View
`genesys_journey_post_views_encodings_validate`	Validate whether an encoding exist for a label/value combination.
`genesys_journey_put_view_schedules`	Update the Schedule for a JourneyView
`genesys_journey_put_view_version`	Update a Journey View by ID and version

genesys_journey_delete_actionmap

Delete single action map. Parameters:

Parameter	Type	Required	Default	Description
`actionMapId`	string	Yes	—	ID of the action map.

Show inputSchema

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

genesys_journey_delete_actiontemplate

Delete a single action template. Parameters:

Parameter	Type	Required	Default	Description
`actionTemplateId`	string	Yes	—	ID of the action template.
`hardDelete`	boolean	No	—	Determines whether Action Template should be soft-deleted (have it’s state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "actionTemplateId": {
      "type": "string",
      "description": "ID of the action template."
    },
    "hardDelete": {
      "type": "boolean",
      "description": "Determines whether Action Template should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default."
    }
  },
  "required": [
    "PCID",
    "actionTemplateId"
  ]
}

genesys_journey_delete_outcome

Delete an outcome. Parameters:

Parameter	Type	Required	Default	Description
`outcomeId`	string	Yes	—	ID of the outcome.

Show inputSchema

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

genesys_journey_delete_outcomes_predictor

Delete an outcome predictor. Parameters:

Parameter	Type	Required	Default	Description
`predictorId`	string	Yes	—	ID of predictor

Show inputSchema

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

genesys_journey_delete_segment

Delete a segment. Parameters:

Parameter	Type	Required	Default	Description
`segmentId`	string	Yes	—	ID of the segment.

Show inputSchema

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

genesys_journey_delete_view

Delete a Journey View by ID Parameters:

Parameter	Type	Required	Default	Description
`viewId`	string	Yes	—	viewId

Show inputSchema

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

genesys_journey_delete_view_schedules

Delete the Schedule of a JourneyView Parameters:

Parameter	Type	Required	Default	Description
`viewId`	string	Yes	—	Journey View Id

Show inputSchema

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

genesys_journey_get_actionmap

Retrieve a single action map. Parameters:

Parameter	Type	Required	Default	Description
`actionMapId`	string	Yes	—	ID of the action map.

Show inputSchema

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

genesys_journey_get_actionmaps

Retrieve all action maps. Parameters:

Parameter	Type	Required	Default	Description
`pageNumber`	integer	No	—	Page number
`pageSize`	integer	No	—	Page size
`sortBy`	string	No	—	Field(s) to sort by. Prefix with ’-’ for descending (e.g. sortBy=displayName,-createdDate).
`filterField`	string	No	—	Field to filter by (e.g. filterField=weight or filterField=action.actionTemplate.id). Requires ‘filterField’ to also be set.
`filterValue`	string	No	—	Value to filter by. Requires ‘filterValue’ to also be set.
`actionMapIds`	any[]	No	—	IDs of action maps to return. Use of this parameter is not compatible with pagination, filtering, sorting or querying. A maximum of 100 action maps are allowed per request.
`queryFields`	any[]	No	—	Action Map field(s) to query on. Requires ‘queryValue’ to also be set.
`queryValue`	string	No	—	Value to query on using fuzzy matching. Requires ‘queryFields’ to also be set.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    },
    "sortBy": {
      "type": "string",
      "description": "Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate)."
    },
    "filterField": {
      "type": "string",
      "description": "Field to filter by (e.g. filterField=weight or filterField=action.actionTemplate.id). Requires 'filterField' to also be set."
    },
    "filterValue": {
      "type": "string",
      "description": "Value to filter by. Requires 'filterValue' to also be set."
    },
    "actionMapIds": {
      "type": "array",
      "description": "IDs of action maps to return. Use of this parameter is not compatible with pagination, filtering, sorting or querying. A maximum of 100 action maps are allowed per request."
    },
    "queryFields": {
      "type": "array",
      "description": "Action Map field(s) to query on. Requires 'queryValue' to also be set."
    },
    "queryValue": {
      "type": "string",
      "description": "Value to query on using fuzzy matching. Requires 'queryFields' to also be set."
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_journey_get_actionmaps_estimates_job

Get status of job. Parameters:

Parameter	Type	Required	Default	Description
`jobId`	string	Yes	—	ID of the job.

Show inputSchema

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

genesys_journey_get_actionmaps_estimates_job_results

Get estimates from completed job. Parameters:

Parameter	Type	Required	Default	Description
`jobId`	string	Yes	—	ID of the job.

Show inputSchema

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

genesys_journey_get_actiontarget

Retrieve a single action target. Parameters:

Parameter	Type	Required	Default	Description
`actionTargetId`	string	Yes	—	ID of the action target.

Show inputSchema

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

genesys_journey_get_actiontargets

Retrieve all action targets. Parameters:

Parameter	Type	Required	Default	Description
`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"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_journey_get_actiontemplate

Retrieve a single action template. Parameters:

Parameter	Type	Required	Default	Description
`actionTemplateId`	string	Yes	—	ID of the action template.

Show inputSchema

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

genesys_journey_get_actiontemplates

Retrieve all action templates. Parameters:

Parameter	Type	Required	Default	Description
`pageNumber`	integer	No	—	Page number
`pageSize`	integer	No	—	Page size
`sortBy`	string	No	—	Field(s) to sort by. Prefix with ’-’ for descending (e.g. sortBy=name,-createdDate).
`mediaType`	string	No	—	Media type
`state`	string	No	—	Action template state.
`queryFields`	any[]	No	—	ActionTemplate field(s) to query on. Requires ‘queryValue’ to also be set.
`queryValue`	string	No	—	Value to query on using fuzzy matching. Requires ‘queryFields’ to also be set.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    },
    "sortBy": {
      "type": "string",
      "description": "Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=name,-createdDate)."
    },
    "mediaType": {
      "type": "string",
      "description": "Media type",
      "enum": [
        "webchat",
        "webMessagingOffer",
        "contentOffer",
        "integrationAction",
        "architectFlow",
        "openAction"
      ]
    },
    "state": {
      "type": "string",
      "description": "Action template state.",
      "enum": [
        "Active",
        "Inactive",
        "Deleted"
      ]
    },
    "queryFields": {
      "type": "array",
      "description": "ActionTemplate field(s) to query on. Requires 'queryValue' to also be set."
    },
    "queryValue": {
      "type": "string",
      "description": "Value to query on using fuzzy matching. Requires 'queryFields' to also be set."
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_journey_get_deployment_customer_ping

Send a ping. Parameters:

Parameter	Type	Required	Default	Description
`deploymentId`	string	Yes	—	The ID of the deployment sending the ping.
`customerCookieId`	string	Yes	—	ID of the customer associated with the ping.
`dl`	string	No	—	Document Location: 1) Web Page URL if overridden or URL fragment identifier (window.location.hash). OR 2) Application screen name that the ping request was sent from in the app. e.g. ‘home’ or ‘help. Pings without this parameter will not return actions.
`dt`	string	No	—	Document Title. A human readable name for the page or screen
`appNamespace`	string	No	—	Namespace of the application (e.g. com.genesys.bancodinero). Used for domain filtering in application sessions
`sessionId`	string	No	—	UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session
`sinceLastBeaconMilliseconds`	integer	No	—	How long (milliseconds) since the last app event or beacon was sent. The response may return a pollInternvalMilliseconds to reduce the frequency of pings.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "The ID of the deployment sending the ping."
    },
    "customerCookieId": {
      "type": "string",
      "description": "ID of the customer associated with the ping."
    },
    "dl": {
      "type": "string",
      "description": "Document Location: 1) Web Page URL if overridden or URL fragment identifier (window.location.hash). OR  2) Application screen name that the ping request was sent from in the app. e.g. 'home' or 'help. Pings without this parameter will not return actions."
    },
    "dt": {
      "type": "string",
      "description": "Document Title.  A human readable name for the page or screen"
    },
    "appNamespace": {
      "type": "string",
      "description": "Namespace of the application (e.g. com.genesys.bancodinero). Used for domain filtering in application sessions"
    },
    "sessionId": {
      "type": "string",
      "description": "UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session"
    },
    "sinceLastBeaconMilliseconds": {
      "type": "integer",
      "description": "How long (milliseconds) since the last app event or beacon was sent. The response may return a pollInternvalMilliseconds to reduce the frequency of pings."
    }
  },
  "required": [
    "PCID",
    "deploymentId",
    "customerCookieId"
  ]
}

genesys_journey_get_outcome

Retrieve a single outcome. Parameters:

Parameter	Type	Required	Default	Description
`outcomeId`	string	Yes	—	ID of the outcome.

Show inputSchema

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

genesys_journey_get_outcomes

Retrieve all outcomes. Parameters:

Parameter	Type	Required	Default	Description
`pageNumber`	integer	No	—	Page number
`pageSize`	integer	No	—	Page size
`sortBy`	string	No	—	Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with ’-’ for descending (e.g. sortBy=displayName,-createdDate).
`outcomeIds`	any[]	No	—	IDs of outcomes to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 20 outcomes are allowed per request.
`queryFields`	any[]	No	—	Outcome field(s) to query on. Requires ‘queryValue’ to also be set.
`queryValue`	string	No	—	Value to query on using fuzzy matching. Requires ‘queryFields’ to also be set.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    },
    "sortBy": {
      "type": "string",
      "description": "Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate)."
    },
    "outcomeIds": {
      "type": "array",
      "description": "IDs of outcomes to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 20 outcomes are allowed per request."
    },
    "queryFields": {
      "type": "array",
      "description": "Outcome field(s) to query on. Requires 'queryValue' to also be set."
    },
    "queryValue": {
      "type": "string",
      "description": "Value to query on using fuzzy matching. Requires 'queryFields' to also be set."
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_journey_get_outcomes_predictor

Retrieve a single outcome predictor. Parameters:

Parameter	Type	Required	Default	Description
`predictorId`	string	Yes	—	ID of predictor

Show inputSchema

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

genesys_journey_get_outcomes_predictors

Retrieve all outcome predictors.

Show inputSchema

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

genesys_journey_get_segment

Retrieve a single segment. Parameters:

Parameter	Type	Required	Default	Description
`segmentId`	string	Yes	—	ID of the segment.

Show inputSchema

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

genesys_journey_get_segments

Retrieve all segments. Parameters:

Parameter	Type	Required	Default	Description
`sortBy`	string	No	—	Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with ’-’ for descending (e.g. sortBy=displayName,-createdDate).
`pageSize`	integer	No	—	Page size
`pageNumber`	integer	No	—	Page number
`isActive`	boolean	No	—	Determines whether or not to show only active segments.
`segmentIds`	any[]	No	—	IDs of segments to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 100 segments are allowed per request.
`queryFields`	any[]	No	—	Segment field(s) to query on. Requires ‘queryValue’ to also be set.
`queryValue`	string	No	—	Value to query on using fuzzy matching. Requires ‘queryFields’ to also be set.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sortBy": {
      "type": "string",
      "description": "Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate)."
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "isActive": {
      "type": "boolean",
      "description": "Determines whether or not to show only active segments."
    },
    "segmentIds": {
      "type": "array",
      "description": "IDs of segments to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 100 segments are allowed per request."
    },
    "queryFields": {
      "type": "array",
      "description": "Segment field(s) to query on. Requires 'queryValue' to also be set."
    },
    "queryValue": {
      "type": "string",
      "description": "Value to query on using fuzzy matching. Requires 'queryFields' to also be set."
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_journey_get_session

Retrieve a single session. Parameters:

Parameter	Type	Required	Default	Description
`sessionId`	string	Yes	—	ID of the session.

Show inputSchema

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

genesys_journey_get_session_events

Retrieve all events for a given session. Parameters:

Parameter	Type	Required	Default	Description
`sessionId`	string	Yes	—	System-generated UUID that represents the session the event is a part of.
`pageSize`	string	No	—	Number of entities to return. Maximum of 200.
`after`	string	No	—	The cursor that points to the end of the set of entities that has been returned.
`eventType`	string	No	—	A comma separated list of journey event types to include in the results.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sessionId": {
      "type": "string",
      "description": "System-generated UUID that represents the session the event is a part of."
    },
    "pageSize": {
      "type": "string",
      "description": "Number of entities to return. Maximum of 200."
    },
    "after": {
      "type": "string",
      "description": "The cursor that points to the end of the set of entities that has been returned."
    },
    "eventType": {
      "type": "string",
      "description": "A comma separated list of journey event types to include in the results.",
      "enum": [
        "com.genesys.journey.OutcomeAchievedEvent",
        "com.genesys.journey.SegmentAssignmentEvent",
        "com.genesys.journey.WebActionEvent",
        "com.genesys.journey.WebEvent",
        "com.genesys.journey.AppEvent"
      ]
    }
  },
  "required": [
    "PCID",
    "sessionId"
  ]
}

genesys_journey_get_session_outcomescores

Retrieve latest outcome score associated with a session for all outcomes. Parameters:

Parameter	Type	Required	Default	Description
`sessionId`	string	Yes	—	ID of the session.

Show inputSchema

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

genesys_journey_get_view

Get a Journey View by ID Parameters:

Parameter	Type	Required	Default	Description
`viewId`	string	Yes	—	viewId

Show inputSchema

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

genesys_journey_get_view_schedules

Get the Schedule for a JourneyView Parameters:

Parameter	Type	Required	Default	Description
`viewId`	string	Yes	—	Journey View Id

Show inputSchema

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

genesys_journey_get_view_version

Get a Journey View by ID and version Parameters:

Parameter	Type	Required	Default	Description
`viewId`	string	Yes	—	viewId
`versionId`	string	Yes	—	versionId

Show inputSchema

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

genesys_journey_get_view_version_chart

Get a Chart by ID Parameters:

Parameter	Type	Required	Default	Description
`viewId`	string	Yes	—	viewId
`journeyViewVersion`	string	Yes	—	Journey View Version
`chartId`	string	Yes	—	chartId

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "viewId": {
      "type": "string",
      "description": "viewId"
    },
    "journeyViewVersion": {
      "type": "string",
      "description": "Journey View Version"
    },
    "chartId": {
      "type": "string",
      "description": "chartId"
    }
  },
  "required": [
    "PCID",
    "viewId",
    "journeyViewVersion",
    "chartId"
  ]
}

genesys_journey_get_view_version_chart_version

Get a Chart by ID and version Parameters:

Parameter	Type	Required	Default	Description
`viewId`	string	Yes	—	viewId
`journeyViewVersion`	string	Yes	—	Journey View Version
`chartId`	string	Yes	—	chartId
`chartVersion`	string	Yes	—	chartVersion

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "viewId": {
      "type": "string",
      "description": "viewId"
    },
    "journeyViewVersion": {
      "type": "string",
      "description": "Journey View Version"
    },
    "chartId": {
      "type": "string",
      "description": "chartId"
    },
    "chartVersion": {
      "type": "string",
      "description": "chartVersion"
    }
  },
  "required": [
    "PCID",
    "viewId",
    "journeyViewVersion",
    "chartId",
    "chartVersion"
  ]
}

genesys_journey_get_view_version_job

Get the job for a journey view version. Parameters:

Parameter	Type	Required	Default	Description
`viewId`	string	Yes	—	Journey View Id
`journeyVersionId`	string	Yes	—	Journey View Version
`jobId`	string	Yes	—	JobId

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "viewId": {
      "type": "string",
      "description": "Journey View Id"
    },
    "journeyVersionId": {
      "type": "string",
      "description": "Journey View Version"
    },
    "jobId": {
      "type": "string",
      "description": "JobId"
    }
  },
  "required": [
    "PCID",
    "viewId",
    "journeyVersionId",
    "jobId"
  ]
}

genesys_journey_get_view_version_job_results

Get the result of a job for a journey view version. Parameters:

Parameter	Type	Required	Default	Description
`viewId`	string	Yes	—	JourneyViewResult id
`journeyViewVersion`	string	Yes	—	Journey View Version
`jobId`	string	Yes	—	Id of the executing job

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "viewId": {
      "type": "string",
      "description": "JourneyViewResult id"
    },
    "journeyViewVersion": {
      "type": "string",
      "description": "Journey View Version"
    },
    "jobId": {
      "type": "string",
      "description": "Id of the executing job"
    }
  },
  "required": [
    "PCID",
    "viewId",
    "journeyViewVersion",
    "jobId"
  ]
}

genesys_journey_get_view_version_job_results_chart

Get the chart result associated with a journey view job. Parameters:

Parameter	Type	Required	Default	Description
`viewId`	string	Yes	—	Journey View Id
`journeyVersionId`	string	Yes	—	Journey View Version
`jobId`	string	Yes	—	JobId
`chartId`	string	Yes	—	ChartId

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "viewId": {
      "type": "string",
      "description": "Journey View Id"
    },
    "journeyVersionId": {
      "type": "string",
      "description": "Journey View Version"
    },
    "jobId": {
      "type": "string",
      "description": "JobId"
    },
    "chartId": {
      "type": "string",
      "description": "ChartId"
    }
  },
  "required": [
    "PCID",
    "viewId",
    "journeyVersionId",
    "jobId",
    "chartId"
  ]
}

genesys_journey_get_view_version_jobs_latest

Get the latest job of a journey view version. Parameters:

Parameter	Type	Required	Default	Description
`viewId`	string	Yes	—	Journey View Id
`journeyVersionId`	string	Yes	—	Journey View Version

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "viewId": {
      "type": "string",
      "description": "Journey View Id"
    },
    "journeyVersionId": {
      "type": "string",
      "description": "Journey View Version"
    }
  },
  "required": [
    "PCID",
    "viewId",
    "journeyVersionId"
  ]
}

genesys_journey_get_views

Get a list of Journey Views Parameters:

Parameter	Type	Required	Default	Description
`pageNumber`	integer	No	—	Page number
`pageSize`	integer	No	—	Page size
`nameOrCreatedBy`	string	No	—	Journey View Name or Created By
`expand`	string	No	—	Parameter to request additional data to return in Journey payload
`id`	string	No	—	Parameter to request a list of Journey Views by id, separated by commas. Limit of 100 items.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    },
    "nameOrCreatedBy": {
      "type": "string",
      "description": "Journey View Name or Created By"
    },
    "expand": {
      "type": "string",
      "description": "Parameter to request additional data to return in Journey payload",
      "enum": [
        "charts"
      ]
    },
    "id": {
      "type": "string",
      "description": "Parameter to request a list of Journey Views by id, separated by commas. Limit of 100 items."
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_journey_get_views_data_details

Get details about the data available for journey queries including oldest and newest event dates

Show inputSchema

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

genesys_journey_get_views_eventdefinition

Get an Event Definition Parameters:

Parameter	Type	Required	Default	Description
`eventDefinitionId`	string	Yes	—	Event Definition ID

Show inputSchema

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

genesys_journey_get_views_eventdefinitions

Get a list of Event Definitions

Show inputSchema

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

genesys_journey_get_views_jobs

Get the jobs for an organization. Parameters:

Parameter	Type	Required	Default	Description
`pageNumber`	integer	No	—	The number of the page to return
`pageSize`	integer	No	—	Max number of entities to return
`interval`	string	No	—	An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval.
`statuses`	string	No	—	Job statuses to filter for

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageNumber": {
      "type": "integer",
      "description": "The number of the page to return"
    },
    "pageSize": {
      "type": "integer",
      "description": "Max number of entities to return"
    },
    "interval": {
      "type": "string",
      "description": "An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval."
    },
    "statuses": {
      "type": "string",
      "description": "Job statuses to filter for"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_journey_get_views_jobs_me

Get my jobs Parameters:

Parameter	Type	Required	Default	Description
`pageNumber`	integer	No	—	The number of the page to return
`pageSize`	integer	No	—	Max number of entities to return
`interval`	string	No	—	An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval.
`statuses`	string	No	—	Job statuses to filter for

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageNumber": {
      "type": "integer",
      "description": "The number of the page to return"
    },
    "pageSize": {
      "type": "integer",
      "description": "Max number of entities to return"
    },
    "interval": {
      "type": "string",
      "description": "An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval."
    },
    "statuses": {
      "type": "string",
      "description": "Job statuses to filter for"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_journey_get_views_schedules

Get the journey schedules for an organization. Parameters:

Parameter	Type	Required	Default	Description
`pageNumber`	integer	No	—	The number of the page to return
`pageSize`	integer	No	—	Max number of entities to return

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageNumber": {
      "type": "integer",
      "description": "The number of the page to return"
    },
    "pageSize": {
      "type": "integer",
      "description": "Max number of entities to return"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_journey_patch_actionmap

Update single action map. Parameters:

Parameter	Type	Required	Default	Description
`actionMapId`	string	Yes	—	ID of the action map.
`action`	object	No	—	action
`actionMapScheduleGroups`	object	No	—	actionMapScheduleGroups
`activation`	object	No	—	activation
`createdDate`	string	No	—	Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`displayName`	string	No	—	Display name of the action map.
`endDate`	string	No	—	Timestamp at which the action map is scheduled to stop firing. 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.
`ignoreFrequencyCap`	boolean	No	—	Override organization-level frequency cap and always offer web engagements from this action map.
`isActive`	boolean	No	—	Whether the action map is active.
`modifiedDate`	string	No	—	Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`pageUrlConditions`	any[]	No	—	URL conditions that a page must match for web actions to be displayable.
`selfUri`	string	No	—	The URI for this object
`startDate`	string	No	—	Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`triggerWithEventConditions`	any[]	No	—	List of event conditions that must be satisfied to trigger the action map.
`triggerWithOutcomePercentileConditions`	any[]	No	—	(deprecated - use triggerWithOutcomeQuantileConditions instead) Percentile conditions for outcomes that must be satisfied to trigger the action map.
`triggerWithOutcomeProbabilityConditions`	any[]	No	—	(deprecated - use triggerWithOutcomeQuantileConditions instead) Probability conditions for outcomes that must be satisfied to trigger the action map.
`triggerWithOutcomeQuantileConditions`	any[]	No	—	Quantile conditions for outcomes that must be satisfied to trigger the action map.
`triggerWithSegments`	any[]	No	—	Trigger action map if any segment in the list is assigned to a given customer.
`version`	integer	No	—	The version of the action map.
`weight`	integer	No	—	Weight of the action map with higher number denoting higher weight.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "actionMapId": {
      "type": "string",
      "description": "ID of the action map."
    },
    "action": {
      "type": "object",
      "description": "action"
    },
    "actionMapScheduleGroups": {
      "type": "object",
      "description": "actionMapScheduleGroups"
    },
    "activation": {
      "type": "object",
      "description": "activation"
    },
    "createdDate": {
      "type": "string",
      "description": "Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "displayName": {
      "type": "string",
      "description": "Display name of the action map."
    },
    "endDate": {
      "type": "string",
      "description": "Timestamp at which the action map is scheduled to stop firing. 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."
    },
    "ignoreFrequencyCap": {
      "type": "boolean",
      "description": "Override organization-level frequency cap and always offer web engagements from this action map."
    },
    "isActive": {
      "type": "boolean",
      "description": "Whether the action map is active."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "pageUrlConditions": {
      "type": "array",
      "description": "URL conditions that a page must match for web actions to be displayable."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "startDate": {
      "type": "string",
      "description": "Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "triggerWithEventConditions": {
      "type": "array",
      "description": "List of event conditions that must be satisfied to trigger the action map."
    },
    "triggerWithOutcomePercentileConditions": {
      "type": "array",
      "description": "(deprecated - use triggerWithOutcomeQuantileConditions instead) Percentile conditions for outcomes that must be satisfied to trigger the action map."
    },
    "triggerWithOutcomeProbabilityConditions": {
      "type": "array",
      "description": "(deprecated - use triggerWithOutcomeQuantileConditions instead) Probability conditions for outcomes that must be satisfied to trigger the action map."
    },
    "triggerWithOutcomeQuantileConditions": {
      "type": "array",
      "description": "Quantile conditions for outcomes that must be satisfied to trigger the action map."
    },
    "triggerWithSegments": {
      "type": "array",
      "description": "Trigger action map if any segment in the list is assigned to a given customer."
    },
    "version": {
      "type": "integer",
      "description": "The version of the action map."
    },
    "weight": {
      "type": "integer",
      "description": "Weight of the action map with higher number denoting higher weight."
    }
  },
  "required": [
    "PCID",
    "actionMapId"
  ]
}

genesys_journey_patch_actiontarget

Update a single action target. Parameters:

Parameter	Type	Required	Default	Description
`actionTargetId`	string	Yes	—	ID of the action target.
`id`	string	No	—	The globally unique identifier for the object.
`name`	string	No	—	name
`selfUri`	string	No	—	The URI for this object
`serviceLevel`	object	No	—	serviceLevel
`shortAbandonThreshold`	integer	No	—	Indicates the non-default short abandon threshold

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "actionTargetId": {
      "type": "string",
      "description": "ID of the action target."
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "name": {
      "type": "string",
      "description": "name"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "serviceLevel": {
      "type": "object",
      "description": "serviceLevel"
    },
    "shortAbandonThreshold": {
      "type": "integer",
      "description": "Indicates the non-default short abandon threshold"
    }
  },
  "required": [
    "PCID",
    "actionTargetId"
  ]
}

genesys_journey_patch_actiontemplate

Update a single action template. Parameters:

Parameter	Type	Required	Default	Description
`actionTemplateId`	string	Yes	—	ID of the action template.
`contentOffer`	object	No	—	contentOffer
`description`	string	No	—	Description of the action template’s functionality.
`mediaType`	string	No	—	Media type of action described by the action template.
`name`	string	No	—	Name of the action template.
`state`	string	No	—	Whether the action template is currently active, inactive or deleted.
`version`	integer	No	—	The version of the action template.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "actionTemplateId": {
      "type": "string",
      "description": "ID of the action template."
    },
    "contentOffer": {
      "type": "object",
      "description": "contentOffer"
    },
    "description": {
      "type": "string",
      "description": "Description of the action template's functionality."
    },
    "mediaType": {
      "type": "string",
      "description": "Media type of action described by the action template.",
      "enum": [
        "webchat",
        "webMessagingOffer",
        "contentOffer",
        "integrationAction",
        "architectFlow",
        "openAction"
      ]
    },
    "name": {
      "type": "string",
      "description": "Name of the action template."
    },
    "state": {
      "type": "string",
      "description": "Whether the action template is currently active, inactive or deleted.",
      "enum": [
        "Active",
        "Inactive",
        "Deleted"
      ]
    },
    "version": {
      "type": "integer",
      "description": "The version of the action template."
    }
  },
  "required": [
    "PCID",
    "actionTemplateId"
  ]
}

genesys_journey_patch_outcome

Update an outcome. Parameters:

Parameter	Type	Required	Default	Description
`outcomeId`	string	Yes	—	ID of the outcome.
`associatedValueField`	object	No	—	associatedValueField
`context`	object	No	—	context
`description`	string	No	—	A description of the outcome.
`displayName`	string	No	—	The display name of the outcome.
`isActive`	boolean	No	—	Whether or not the outcome is active.
`isPositive`	boolean	No	—	Whether or not the outcome is positive.
`journey`	object	No	—	journey
`version`	integer	No	—	The version of the outcome.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "outcomeId": {
      "type": "string",
      "description": "ID of the outcome."
    },
    "associatedValueField": {
      "type": "object",
      "description": "associatedValueField"
    },
    "context": {
      "type": "object",
      "description": "context"
    },
    "description": {
      "type": "string",
      "description": "A description of the outcome."
    },
    "displayName": {
      "type": "string",
      "description": "The display name of the outcome."
    },
    "isActive": {
      "type": "boolean",
      "description": "Whether or not the outcome is active."
    },
    "isPositive": {
      "type": "boolean",
      "description": "Whether or not the outcome is positive."
    },
    "journey": {
      "type": "object",
      "description": "journey"
    },
    "version": {
      "type": "integer",
      "description": "The version of the outcome."
    }
  },
  "required": [
    "PCID",
    "outcomeId"
  ]
}

genesys_journey_patch_segment

Update a segment. Parameters:

Parameter	Type	Required	Default	Description
`segmentId`	string	Yes	—	ID of the segment.
`assignmentExpirationDays`	integer	No	—	Time, in days, from when the segment is assigned until it is automatically unassigned.
`color`	string	No	—	The hexadecimal color value of the segment.
`context`	object	No	—	context
`description`	string	No	—	A description of the segment.
`displayName`	string	No	—	The display name of the segment.
`externalSegment`	object	No	—	externalSegment
`isActive`	boolean	No	—	Whether or not the segment is active.
`journey`	object	No	—	journey
`shouldDisplayToAgent`	boolean	No	—	Whether or not the segment should be displayed to agent/supervisor users.
`version`	integer	No	—	The version of the segment.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "segmentId": {
      "type": "string",
      "description": "ID of the segment."
    },
    "assignmentExpirationDays": {
      "type": "integer",
      "description": "Time, in days, from when the segment is assigned until it is automatically unassigned."
    },
    "color": {
      "type": "string",
      "description": "The hexadecimal color value of the segment."
    },
    "context": {
      "type": "object",
      "description": "context"
    },
    "description": {
      "type": "string",
      "description": "A description of the segment."
    },
    "displayName": {
      "type": "string",
      "description": "The display name of the segment."
    },
    "externalSegment": {
      "type": "object",
      "description": "externalSegment"
    },
    "isActive": {
      "type": "boolean",
      "description": "Whether or not the segment is active."
    },
    "journey": {
      "type": "object",
      "description": "journey"
    },
    "shouldDisplayToAgent": {
      "type": "boolean",
      "description": "Whether or not the segment should be displayed to agent/supervisor users."
    },
    "version": {
      "type": "integer",
      "description": "The version of the segment."
    }
  },
  "required": [
    "PCID",
    "segmentId"
  ]
}

genesys_journey_patch_view_version_job

Update the job for a journey view version. Only the status can be changed and only to Cancelled Parameters:

Parameter	Type	Required	Default	Description
`viewId`	string	Yes	—	Journey View Id
`journeyVersionId`	string	Yes	—	Journey View Version
`jobId`	string	Yes	—	JobId
`dateCompleted`	string	Yes	—	Timestamp of completion. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateCompletionEstimated`	string	Yes	—	Timestamp for the estimated time of completion. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateCreated`	string	Yes	—	Timestamp of execution. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`estimatedCompletionMargin`	integer	Yes	—	Margin of error of the estimated time of completion
`id`	string	No	—	The globally unique identifier for the object.
`journeyView`	object	Yes	—	A journey view
`selfUri`	string	No	—	The URI for this object
`status`	string	Yes	—	The status of the job
`userId`	string	Yes	—	Id of the user who submitted the request

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "viewId": {
      "type": "string",
      "description": "Journey View Id"
    },
    "journeyVersionId": {
      "type": "string",
      "description": "Journey View Version"
    },
    "jobId": {
      "type": "string",
      "description": "JobId"
    },
    "dateCompleted": {
      "type": "string",
      "description": "Timestamp of completion. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateCompletionEstimated": {
      "type": "string",
      "description": "Timestamp for the estimated time of completion. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateCreated": {
      "type": "string",
      "description": "Timestamp of execution. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "estimatedCompletionMargin": {
      "type": "integer",
      "description": "Margin of error of the estimated time of completion"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "journeyView": {
      "type": "object",
      "description": "A journey view"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "status": {
      "type": "string",
      "description": "The status of the job",
      "enum": [
        "Accepted",
        "Executing",
        "Complete",
        "Failed",
        "Cancelled",
        "Scheduled"
      ]
    },
    "userId": {
      "type": "string",
      "description": "Id of the user who submitted the request"
    }
  },
  "required": [
    "PCID",
    "viewId",
    "journeyVersionId",
    "jobId",
    "dateCompleted",
    "dateCompletionEstimated",
    "dateCreated",
    "estimatedCompletionMargin",
    "journeyView",
    "status",
    "userId"
  ]
}

genesys_journey_post_actionmaps

Create an action map. Parameters:

Parameter	Type	Required	Default	Description
`action`	object	No	—	action
`actionMapScheduleGroups`	object	No	—	actionMapScheduleGroups
`activation`	object	No	—	activation
`createdDate`	string	No	—	Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`displayName`	string	No	—	Display name of the action map.
`endDate`	string	No	—	Timestamp at which the action map is scheduled to stop firing. 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.
`ignoreFrequencyCap`	boolean	No	—	Override organization-level frequency cap and always offer web engagements from this action map.
`isActive`	boolean	No	—	Whether the action map is active.
`modifiedDate`	string	No	—	Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`pageUrlConditions`	any[]	No	—	URL conditions that a page must match for web actions to be displayable.
`selfUri`	string	No	—	The URI for this object
`startDate`	string	No	—	Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`triggerWithEventConditions`	any[]	No	—	List of event conditions that must be satisfied to trigger the action map.
`triggerWithOutcomePercentileConditions`	any[]	No	—	(deprecated - use triggerWithOutcomeQuantileConditions instead) Percentile conditions for outcomes that must be satisfied to trigger the action map.
`triggerWithOutcomeProbabilityConditions`	any[]	No	—	(deprecated - use triggerWithOutcomeQuantileConditions instead) Probability conditions for outcomes that must be satisfied to trigger the action map.
`triggerWithOutcomeQuantileConditions`	any[]	No	—	Quantile conditions for outcomes that must be satisfied to trigger the action map.
`triggerWithSegments`	any[]	No	—	Trigger action map if any segment in the list is assigned to a given customer.
`version`	integer	No	—	The version of the action map.
`weight`	integer	No	—	Weight of the action map with higher number denoting higher weight.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "action": {
      "type": "object",
      "description": "action"
    },
    "actionMapScheduleGroups": {
      "type": "object",
      "description": "actionMapScheduleGroups"
    },
    "activation": {
      "type": "object",
      "description": "activation"
    },
    "createdDate": {
      "type": "string",
      "description": "Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "displayName": {
      "type": "string",
      "description": "Display name of the action map."
    },
    "endDate": {
      "type": "string",
      "description": "Timestamp at which the action map is scheduled to stop firing. 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."
    },
    "ignoreFrequencyCap": {
      "type": "boolean",
      "description": "Override organization-level frequency cap and always offer web engagements from this action map."
    },
    "isActive": {
      "type": "boolean",
      "description": "Whether the action map is active."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "pageUrlConditions": {
      "type": "array",
      "description": "URL conditions that a page must match for web actions to be displayable."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "startDate": {
      "type": "string",
      "description": "Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "triggerWithEventConditions": {
      "type": "array",
      "description": "List of event conditions that must be satisfied to trigger the action map."
    },
    "triggerWithOutcomePercentileConditions": {
      "type": "array",
      "description": "(deprecated - use triggerWithOutcomeQuantileConditions instead) Percentile conditions for outcomes that must be satisfied to trigger the action map."
    },
    "triggerWithOutcomeProbabilityConditions": {
      "type": "array",
      "description": "(deprecated - use triggerWithOutcomeQuantileConditions instead) Probability conditions for outcomes that must be satisfied to trigger the action map."
    },
    "triggerWithOutcomeQuantileConditions": {
      "type": "array",
      "description": "Quantile conditions for outcomes that must be satisfied to trigger the action map."
    },
    "triggerWithSegments": {
      "type": "array",
      "description": "Trigger action map if any segment in the list is assigned to a given customer."
    },
    "version": {
      "type": "integer",
      "description": "The version of the action map."
    },
    "weight": {
      "type": "integer",
      "description": "Weight of the action map with higher number denoting higher weight."
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_journey_post_actionmaps_estimates_jobs

Query for estimates Parameters:

Parameter	Type	Required	Default	Description
`outcomeCriteria`	object	No	—	outcomeCriteria
`segmentIds`	any[]	No	—	List of Segment IDs.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "outcomeCriteria": {
      "type": "object",
      "description": "outcomeCriteria"
    },
    "segmentIds": {
      "type": "array",
      "description": "List of Segment IDs."
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_journey_post_actiontemplates

Create a single action template. Parameters:

Parameter	Type	Required	Default	Description
`contentOffer`	object	No	—	contentOffer
`createdDate`	string	No	—	Date when action template was created in ISO-8601 format.
`description`	string	No	—	Description of the action template’s functionality.
`id`	string	No	—	The globally unique identifier for the object.
`mediaType`	string	No	—	Media type of action described by the action template.
`modifiedDate`	string	No	—	Date when action template was last modified in ISO-8601 format.
`name`	string	No	—	Name of the action template.
`selfUri`	string	No	—	The URI for this object
`state`	string	No	—	Whether the action template is currently active, inactive or deleted.
`version`	integer	No	—	The version of the action template.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contentOffer": {
      "type": "object",
      "description": "contentOffer"
    },
    "createdDate": {
      "type": "string",
      "description": "Date when action template was created in ISO-8601 format."
    },
    "description": {
      "type": "string",
      "description": "Description of the action template's functionality."
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "mediaType": {
      "type": "string",
      "description": "Media type of action described by the action template.",
      "enum": [
        "webchat",
        "webMessagingOffer",
        "contentOffer",
        "integrationAction",
        "architectFlow",
        "openAction"
      ]
    },
    "modifiedDate": {
      "type": "string",
      "description": "Date when action template was last modified in ISO-8601 format."
    },
    "name": {
      "type": "string",
      "description": "Name of the action template."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "state": {
      "type": "string",
      "description": "Whether the action template is currently active, inactive or deleted.",
      "enum": [
        "Active",
        "Inactive",
        "Deleted"
      ]
    },
    "version": {
      "type": "integer",
      "description": "The version of the action template."
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_journey_post_deployment_actionevent

Sends an action event, which is used for changing the state of actions that have been offered to the user. Parameters:

Parameter	Type	Required	Default	Description
`deploymentId`	string	Yes	—	The ID of the deployment sending the beacon.
`actionId`	string	Yes	—	UUID for the action, as returned by the Ping endpoint when the action was qualified.
`actionState`	string	Yes	—	State the action is transitioning to.
`errorCode`	string	No	—	Client defined error code (when state transitions to errored)
`errorMessage`	string	No	—	Message of the error returned when the action fails (when state transitions to errored)
`id`	string	No	—	The globally unique identifier for the object.
`selfUri`	string	No	—	The URI for this object
`sessionId`	string	Yes	—	UUID of the customer session for this action.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "The ID of the deployment sending the beacon."
    },
    "actionId": {
      "type": "string",
      "description": "UUID for the action, as returned by the Ping endpoint when the action was qualified."
    },
    "actionState": {
      "type": "string",
      "description": "State the action is transitioning to.",
      "enum": [
        "accepted",
        "rejected",
        "timedout",
        "errored",
        "ignored",
        "qualified",
        "offered",
        "started",
        "engaged",
        "qualifiedOutsideSchedule",
        "offeredOutsideSchedule",
        "abandoned",
        "completed",
        "frequencyCapReached"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Client defined error code (when state transitions to errored)"
    },
    "errorMessage": {
      "type": "string",
      "description": "Message of the error returned when the action fails (when state transitions to errored)"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "sessionId": {
      "type": "string",
      "description": "UUID of the customer session for this action."
    }
  },
  "required": [
    "PCID",
    "deploymentId",
    "actionId",
    "actionState",
    "sessionId"
  ]
}

genesys_journey_post_deployment_appevents

Send a journey app event, used for tracking customer activity on an application. Parameters:

Parameter	Type	Required	Default	Description
`deploymentId`	string	Yes	—	The ID of the deployment sending the app event.
`app`	object	No	—	app
`attributes`	object	No	—	User-defined attributes associated with a particular event. These attributes provide additional context about the event. For example, items_in_cart or subscription_level.
`createdDate`	string	No	—	UTC timestamp indicating when the event actually took place, events older than an hour will be rejected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`customerCookieId`	string	No	—	A UUID representing the customer associated with the app event. This is expected to be set per application install or device and can be used to identify a single customer across multiple sessions. This identifier, along with others passed as traits, is used for identity resolution.
`device`	object	No	—	device
`eventName`	string	No	—	Represents the action the customer performed. Event types are created for each unique event name and can be faceted on in segment and outcome conditions. A valid event name must only contain alphanumeric characters and underscores. A good event name is typically an object followed by the action performed in past tense, e.g. screen_viewed, search_performed, user_registered.
`networkConnectivity`	object	No	—	networkConnectivity
`referrerUrl`	string	No	—	The referrer URL of the first event in the app session.
`screenName`	string	No	—	The name of the screen, view, or fragment in the app where the event took place.
`sdkLibrary`	object	No	—	sdkLibrary
`searchQuery`	string	No	—	Represents the keywords in a customer search query.
`traits`	object	No	—	Traits are attributes intrinsic to the customer that may be sent in selected events, (e.g. email, givenName, cellPhone). Traits are used to collect information for identity resolution. For example, the same person might be using an application on different devices which might create two sessions with different customerIds. Additional information can be provided as traits to help link those two sessions and customers to a single external contact through common identifiers that were submitted via a form fill, message, or other input in both sessions.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "The ID of the deployment sending the app event."
    },
    "app": {
      "type": "object",
      "description": "app"
    },
    "attributes": {
      "type": "object",
      "description": "User-defined attributes associated with a particular event. These attributes provide additional context about the event. For example, items_in_cart or subscription_level."
    },
    "createdDate": {
      "type": "string",
      "description": "UTC timestamp indicating when the event actually took place, events older than an hour will be rejected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "customerCookieId": {
      "type": "string",
      "description": "A UUID representing the customer associated with the app event. This is expected to be set per application install or device and can be used to identify a single customer across multiple sessions. This identifier, along with others passed as traits, is used for identity resolution."
    },
    "device": {
      "type": "object",
      "description": "device"
    },
    "eventName": {
      "type": "string",
      "description": "Represents the action the customer performed. Event types are created for each unique event name and can be faceted on in segment and outcome conditions. A valid event name must only contain alphanumeric characters and underscores. A good event name is typically an object followed by the action performed in past tense, e.g. screen_viewed, search_performed, user_registered."
    },
    "networkConnectivity": {
      "type": "object",
      "description": "networkConnectivity"
    },
    "referrerUrl": {
      "type": "string",
      "description": "The referrer URL of the first event in the app session."
    },
    "screenName": {
      "type": "string",
      "description": "The name of the screen, view, or fragment in the app where the event took place."
    },
    "sdkLibrary": {
      "type": "object",
      "description": "sdkLibrary"
    },
    "searchQuery": {
      "type": "string",
      "description": "Represents the keywords in a customer search query."
    },
    "traits": {
      "type": "object",
      "description": "Traits are attributes intrinsic to the customer that may be sent in selected events, (e.g. email, givenName, cellPhone). Traits are used to collect information for identity resolution. For example, the same person might be using an application on different devices which might create two sessions with different customerIds. Additional information can be provided as traits to help link those two sessions and customers to a single external contact through common identifiers that were submitted via a form fill, message, or other input in both sessions."
    }
  },
  "required": [
    "PCID",
    "deploymentId"
  ]
}

genesys_journey_post_deployment_webevents

Send a journey web event, used for tracking customer activity on a website. Parameters:

Parameter	Type	Required	Default	Description
`deploymentId`	string	Yes	—	The ID of the deployment sending the web event.
`attributes`	object	No	—	User-defined attributes associated with a particular event. These attributes provide additional context about the event. For example, items_in_cart or subscription_level.
`browser`	object	No	—	browser
`createdDate`	string	No	—	UTC timestamp indicating when the event actually took place, events older than an hour will be rejected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`customerCookieId`	string	No	—	A UUID representing the customer making the request.
`device`	object	No	—	device
`eventName`	string	No	—	Represents the action the customer performed. Event types are created for each unique event name and can be faceted on in segment and outcome conditions. A valid event name must only contain alphanumeric characters and underscores. A good event name is typically an object followed by the action performed in past tense, e.g. page_viewed, order_completed, user_registered.
`ipAddress`	string	No	—	Customer’s IP address.
`page`	object	No	—	page
`referrerUrl`	string	No	—	Identifies the referrer URL that originally generated the request for the current page being viewed.
`searchQuery`	string	No	—	Represents the keywords in a customer search query.
`traits`	object	No	—	Traits are attributes intrinsic to the customer that may be sent in selected events, e.g. email, givenName, cellPhone. Traits are used to collect information for identity resolution. For example, the same person might be using an application on different devices which might create two sessions with different customerIds. Additional information can be provided as traits to help link those two sessions and customers to a single external contact through common identifiers that were submitted via a form fill, message, or other input in both sessions.
`userAgentString`	string	No	—	Override for HTTP User-Agent string from request header (see https://tools.ietf.org/html/rfc1945#section-10.15).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "The ID of the deployment sending the web event."
    },
    "attributes": {
      "type": "object",
      "description": "User-defined attributes associated with a particular event. These attributes provide additional context about the event. For example, items_in_cart or subscription_level."
    },
    "browser": {
      "type": "object",
      "description": "browser"
    },
    "createdDate": {
      "type": "string",
      "description": "UTC timestamp indicating when the event actually took place, events older than an hour will be rejected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "customerCookieId": {
      "type": "string",
      "description": "A UUID representing the customer making the request."
    },
    "device": {
      "type": "object",
      "description": "device"
    },
    "eventName": {
      "type": "string",
      "description": "Represents the action the customer performed. Event types are created for each unique event name and can be faceted on in segment and outcome conditions. A valid event name must only contain alphanumeric characters and underscores. A good event name is typically an object followed by the action performed in past tense, e.g. page_viewed, order_completed, user_registered."
    },
    "ipAddress": {
      "type": "string",
      "description": "Customer's IP address."
    },
    "page": {
      "type": "object",
      "description": "page"
    },
    "referrerUrl": {
      "type": "string",
      "description": "Identifies the referrer URL that originally generated the request for the current page being viewed."
    },
    "searchQuery": {
      "type": "string",
      "description": "Represents the keywords in a customer search query."
    },
    "traits": {
      "type": "object",
      "description": "Traits are attributes intrinsic to the customer that may be sent in selected events, e.g. email, givenName, cellPhone. Traits are used to collect information for identity resolution. For example, the same person might be using an application on different devices which might create two sessions with different customerIds. Additional information can be provided as traits to help link those two sessions and customers to a single external contact through common identifiers that were submitted via a form fill, message, or other input in both sessions."
    },
    "userAgentString": {
      "type": "string",
      "description": "Override for HTTP User-Agent string from request header (see https://tools.ietf.org/html/rfc1945#section-10.15)."
    }
  },
  "required": [
    "PCID",
    "deploymentId"
  ]
}

genesys_journey_post_flows_paths_query

Query for flow paths. Parameters:

Parameter	Type	Required	Default	Description
`category`	string	No	—	Category (use case) of the paths within a given domain.
`flows`	any[]	No	—	List of flows to query the paths result.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "category": {
      "type": "string",
      "description": "Category (use case) of the paths within a given domain.",
      "enum": [
        "All",
        "Abandoned",
        "AgentEscalation",
        "Complete",
        "Disconnect",
        "Error",
        "RecognitionFailure",
        "Transfer"
      ]
    },
    "flows": {
      "type": "array",
      "description": "List of flows to query the paths result."
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_journey_post_outcomes

Create an outcome. Parameters:

Parameter	Type	Required	Default	Description
`associatedValueField`	object	No	—	associatedValueField
`context`	object	No	—	context
`description`	string	No	—	A description of the outcome.
`displayName`	string	No	—	The display name of the outcome.
`isActive`	boolean	No	—	Whether or not the outcome is active.
`isPositive`	boolean	No	—	Whether or not the outcome is positive.
`journey`	object	No	—	journey
`version`	integer	No	—	The version of the outcome.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "associatedValueField": {
      "type": "object",
      "description": "associatedValueField"
    },
    "context": {
      "type": "object",
      "description": "context"
    },
    "description": {
      "type": "string",
      "description": "A description of the outcome."
    },
    "displayName": {
      "type": "string",
      "description": "The display name of the outcome."
    },
    "isActive": {
      "type": "boolean",
      "description": "Whether or not the outcome is active."
    },
    "isPositive": {
      "type": "boolean",
      "description": "Whether or not the outcome is positive."
    },
    "journey": {
      "type": "object",
      "description": "journey"
    },
    "version": {
      "type": "integer",
      "description": "The version of the outcome."
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_journey_post_outcomes_predictors

Create an outcome predictor. Parameters:

Parameter	Type	Required	Default	Description
`outcome`	object	No	—	outcome

Show inputSchema

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

genesys_journey_post_segments

Create a segment. Parameters:

Parameter	Type	Required	Default	Description
`assignmentExpirationDays`	integer	No	—	Time, in days, from when the segment is assigned until it is automatically unassigned.
`color`	string	No	—	The hexadecimal color value of the segment.
`context`	object	No	—	context
`description`	string	No	—	A description of the segment.
`displayName`	string	No	—	The display name of the segment.
`externalSegment`	object	No	—	externalSegment
`isActive`	boolean	No	—	Whether or not the segment is active.
`journey`	object	No	—	journey
`shouldDisplayToAgent`	boolean	No	—	Whether or not the segment should be displayed to agent/supervisor users.
`version`	integer	No	—	The version of the segment.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "assignmentExpirationDays": {
      "type": "integer",
      "description": "Time, in days, from when the segment is assigned until it is automatically unassigned."
    },
    "color": {
      "type": "string",
      "description": "The hexadecimal color value of the segment."
    },
    "context": {
      "type": "object",
      "description": "context"
    },
    "description": {
      "type": "string",
      "description": "A description of the segment."
    },
    "displayName": {
      "type": "string",
      "description": "The display name of the segment."
    },
    "externalSegment": {
      "type": "object",
      "description": "externalSegment"
    },
    "isActive": {
      "type": "boolean",
      "description": "Whether or not the segment is active."
    },
    "journey": {
      "type": "object",
      "description": "journey"
    },
    "shouldDisplayToAgent": {
      "type": "boolean",
      "description": "Whether or not the segment should be displayed to agent/supervisor users."
    },
    "version": {
      "type": "integer",
      "description": "The version of the segment."
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_journey_post_view_schedules

Add a new Schedule to a JourneyView Parameters:

Parameter	Type	Required	Default	Description
`viewId`	string	Yes	—	Journey View Id
`dateModified`	string	Yes	—	Timestamp of last update. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`frequency`	string	Yes	—	Frequency of execution
`id`	string	No	—	The globally unique identifier for the object.
`selfUri`	string	No	—	The URI for this object
`user`	object	Yes	—	user

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "viewId": {
      "type": "string",
      "description": "Journey View Id"
    },
    "dateModified": {
      "type": "string",
      "description": "Timestamp of last update. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "frequency": {
      "type": "string",
      "description": "Frequency of execution",
      "enum": [
        "Daily",
        "Weekly",
        "Monthly"
      ]
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "user": {
      "type": "object",
      "description": "user"
    }
  },
  "required": [
    "PCID",
    "viewId",
    "dateModified",
    "frequency",
    "user"
  ]
}

genesys_journey_post_view_version_jobs

Submit a job request for a journey view version. Parameters:

Parameter	Type	Required	Default	Description
`viewId`	string	Yes	—	Journey View Id
`journeyVersionId`	string	Yes	—	Journey View Version

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "viewId": {
      "type": "string",
      "description": "Journey View Id"
    },
    "journeyVersionId": {
      "type": "string",
      "description": "Journey View Version"
    }
  },
  "required": [
    "PCID",
    "viewId",
    "journeyVersionId"
  ]
}

genesys_journey_post_view_versions

Update a Journey View by ID Parameters:

Parameter	Type	Required	Default	Description
`viewId`	string	Yes	—	viewId
`charts`	any[]	No	—	A list of charts to measure within context of the elements of the the journey view
`createdBy`	object	No	—	createdBy
`dateCreated`	string	No	—	The date when the journey view was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	The date when this version of the journey view was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`description`	string	No	—	A description of the journey view
`duration`	string	No	—	A relative timeframe for the journey view, expressed as an ISO 8601 duration. Only one of interval or duration must be specified. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
`elements`	any[]	Yes	—	The elements within the journey view
`id`	string	No	—	The globally unique identifier for the object.
`interval`	string	No	—	An absolute timeframe for the journey view, expressed as an ISO 8601 interval. Only one of interval or duration must be specified. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`modifiedBy`	object	No	—	modifiedBy
`name`	string	No	—	name
`selfUri`	string	No	—	The URI for this object
`version`	integer	No	—	The version of the journey view

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "viewId": {
      "type": "string",
      "description": "viewId"
    },
    "charts": {
      "type": "array",
      "description": "A list of charts to measure within context of the elements of the the journey view"
    },
    "createdBy": {
      "type": "object",
      "description": "createdBy"
    },
    "dateCreated": {
      "type": "string",
      "description": "The date when the journey view was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "The date when this version of the journey view was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "description": {
      "type": "string",
      "description": "A description of the journey view"
    },
    "duration": {
      "type": "string",
      "description": "A relative timeframe for the journey view, expressed as an ISO 8601 duration. Only one of interval or duration must be specified. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "elements": {
      "type": "array",
      "description": "The elements within the journey view"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "interval": {
      "type": "string",
      "description": "An absolute timeframe for the journey view, expressed as an ISO 8601 interval. Only one of interval or duration must be specified. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "modifiedBy": {
      "type": "object",
      "description": "modifiedBy"
    },
    "name": {
      "type": "string",
      "description": "name"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "version": {
      "type": "integer",
      "description": "The version of the journey view"
    }
  },
  "required": [
    "PCID",
    "viewId",
    "elements"
  ]
}

genesys_journey_post_views

Create a new Journey View Parameters:

Parameter	Type	Required	Default	Description
`charts`	any[]	No	—	A list of charts to measure within context of the elements of the the journey view
`createdBy`	object	No	—	createdBy
`dateCreated`	string	No	—	The date when the journey view was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	The date when this version of the journey view was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`description`	string	No	—	A description of the journey view
`duration`	string	No	—	A relative timeframe for the journey view, expressed as an ISO 8601 duration. Only one of interval or duration must be specified. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
`elements`	any[]	Yes	—	The elements within the journey view
`id`	string	No	—	The globally unique identifier for the object.
`interval`	string	No	—	An absolute timeframe for the journey view, expressed as an ISO 8601 interval. Only one of interval or duration must be specified. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`modifiedBy`	object	No	—	modifiedBy
`name`	string	No	—	name
`selfUri`	string	No	—	The URI for this object
`version`	integer	No	—	The version of the journey view

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "charts": {
      "type": "array",
      "description": "A list of charts to measure within context of the elements of the the journey view"
    },
    "createdBy": {
      "type": "object",
      "description": "createdBy"
    },
    "dateCreated": {
      "type": "string",
      "description": "The date when the journey view was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "The date when this version of the journey view was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "description": {
      "type": "string",
      "description": "A description of the journey view"
    },
    "duration": {
      "type": "string",
      "description": "A relative timeframe for the journey view, expressed as an ISO 8601 duration. Only one of interval or duration must be specified. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "elements": {
      "type": "array",
      "description": "The elements within the journey view"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "interval": {
      "type": "string",
      "description": "An absolute timeframe for the journey view, expressed as an ISO 8601 interval. Only one of interval or duration must be specified. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "modifiedBy": {
      "type": "object",
      "description": "modifiedBy"
    },
    "name": {
      "type": "string",
      "description": "name"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "version": {
      "type": "integer",
      "description": "The version of the journey view"
    }
  },
  "required": [
    "PCID",
    "elements"
  ]
}

genesys_journey_post_views_encodings_validate

Validate whether an encoding exist for a label/value combination. Parameters:

Parameter	Type	Required	Default	Description
`body`	any[]	No	—	Request body

Show inputSchema

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

genesys_journey_put_view_schedules

Update the Schedule for a JourneyView Parameters:

Parameter	Type	Required	Default	Description
`viewId`	string	Yes	—	Journey View Id
`dateModified`	string	Yes	—	Timestamp of last update. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`frequency`	string	Yes	—	Frequency of execution
`id`	string	No	—	The globally unique identifier for the object.
`selfUri`	string	No	—	The URI for this object
`user`	object	Yes	—	user

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "viewId": {
      "type": "string",
      "description": "Journey View Id"
    },
    "dateModified": {
      "type": "string",
      "description": "Timestamp of last update. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "frequency": {
      "type": "string",
      "description": "Frequency of execution",
      "enum": [
        "Daily",
        "Weekly",
        "Monthly"
      ]
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "user": {
      "type": "object",
      "description": "user"
    }
  },
  "required": [
    "PCID",
    "viewId",
    "dateModified",
    "frequency",
    "user"
  ]
}

genesys_journey_put_view_version

Update a Journey View by ID and version Parameters:

Parameter	Type	Required	Default	Description
`viewId`	string	Yes	—	viewId
`versionId`	string	Yes	—	versionId
`charts`	any[]	No	—	A list of charts to measure within context of the elements of the the journey view
`createdBy`	object	No	—	createdBy
`dateCreated`	string	No	—	The date when the journey view was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	The date when this version of the journey view was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`description`	string	No	—	A description of the journey view
`duration`	string	No	—	A relative timeframe for the journey view, expressed as an ISO 8601 duration. Only one of interval or duration must be specified. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
`elements`	any[]	Yes	—	The elements within the journey view
`id`	string	No	—	The globally unique identifier for the object.
`interval`	string	No	—	An absolute timeframe for the journey view, expressed as an ISO 8601 interval. Only one of interval or duration must be specified. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`modifiedBy`	object	No	—	modifiedBy
`name`	string	No	—	name
`selfUri`	string	No	—	The URI for this object
`version`	integer	No	—	The version of the journey view

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "viewId": {
      "type": "string",
      "description": "viewId"
    },
    "versionId": {
      "type": "string",
      "description": "versionId"
    },
    "charts": {
      "type": "array",
      "description": "A list of charts to measure within context of the elements of the the journey view"
    },
    "createdBy": {
      "type": "object",
      "description": "createdBy"
    },
    "dateCreated": {
      "type": "string",
      "description": "The date when the journey view was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "The date when this version of the journey view was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "description": {
      "type": "string",
      "description": "A description of the journey view"
    },
    "duration": {
      "type": "string",
      "description": "A relative timeframe for the journey view, expressed as an ISO 8601 duration. Only one of interval or duration must be specified. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "elements": {
      "type": "array",
      "description": "The elements within the journey view"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "interval": {
      "type": "string",
      "description": "An absolute timeframe for the journey view, expressed as an ISO 8601 interval. Only one of interval or duration must be specified. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "modifiedBy": {
      "type": "object",
      "description": "modifiedBy"
    },
    "name": {
      "type": "string",
      "description": "name"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "version": {
      "type": "integer",
      "description": "The version of the journey view"
    }
  },
  "required": [
    "PCID",
    "viewId",
    "versionId",
    "elements"
  ]
}

Triggers API

Platform API

Embedded MCP Servers

Application MCP Servers

​Tools

​genesys_journey_delete_actionmap

​genesys_journey_delete_actiontemplate

​genesys_journey_delete_outcome

​genesys_journey_delete_outcomes_predictor

​genesys_journey_delete_segment

​genesys_journey_delete_view

​genesys_journey_delete_view_schedules

​genesys_journey_get_actionmap

​genesys_journey_get_actionmaps

​genesys_journey_get_actionmaps_estimates_job

​genesys_journey_get_actionmaps_estimates_job_results

​genesys_journey_get_actiontarget

​genesys_journey_get_actiontargets

​genesys_journey_get_actiontemplate

​genesys_journey_get_actiontemplates

​genesys_journey_get_deployment_customer_ping

​genesys_journey_get_outcome

​genesys_journey_get_outcomes

​genesys_journey_get_outcomes_predictor

​genesys_journey_get_outcomes_predictors

​genesys_journey_get_segment

​genesys_journey_get_segments

​genesys_journey_get_session

​genesys_journey_get_session_events

​genesys_journey_get_session_outcomescores

​genesys_journey_get_view

​genesys_journey_get_view_schedules

​genesys_journey_get_view_version

​genesys_journey_get_view_version_chart

​genesys_journey_get_view_version_chart_version

​genesys_journey_get_view_version_job

​genesys_journey_get_view_version_job_results

​genesys_journey_get_view_version_job_results_chart

​genesys_journey_get_view_version_jobs_latest

​genesys_journey_get_views

​genesys_journey_get_views_data_details

​genesys_journey_get_views_eventdefinition

​genesys_journey_get_views_eventdefinitions

​genesys_journey_get_views_jobs

​genesys_journey_get_views_jobs_me

​genesys_journey_get_views_schedules

​genesys_journey_patch_actionmap

​genesys_journey_patch_actiontarget

​genesys_journey_patch_actiontemplate

​genesys_journey_patch_outcome

​genesys_journey_patch_segment

​genesys_journey_patch_view_version_job

​genesys_journey_post_actionmaps

​genesys_journey_post_actionmaps_estimates_jobs

​genesys_journey_post_actiontemplates

​genesys_journey_post_deployment_actionevent

​genesys_journey_post_deployment_appevents

​genesys_journey_post_deployment_webevents

​genesys_journey_post_flows_paths_query

​genesys_journey_post_outcomes

​genesys_journey_post_outcomes_predictors

​genesys_journey_post_segments

​genesys_journey_post_view_schedules

​genesys_journey_post_view_version_jobs

​genesys_journey_post_view_versions

​genesys_journey_post_views

​genesys_journey_post_views_encodings_validate

​genesys_journey_put_view_schedules

​genesys_journey_put_view_version

Tools

genesys_journey_delete_actionmap

genesys_journey_delete_actiontemplate

genesys_journey_delete_outcome

genesys_journey_delete_outcomes_predictor

genesys_journey_delete_segment

genesys_journey_delete_view

genesys_journey_delete_view_schedules

genesys_journey_get_actionmap

genesys_journey_get_actionmaps

genesys_journey_get_actionmaps_estimates_job

genesys_journey_get_actionmaps_estimates_job_results

genesys_journey_get_actiontarget

genesys_journey_get_actiontargets

genesys_journey_get_actiontemplate

genesys_journey_get_actiontemplates

genesys_journey_get_deployment_customer_ping

genesys_journey_get_outcome

genesys_journey_get_outcomes

genesys_journey_get_outcomes_predictor

genesys_journey_get_outcomes_predictors

genesys_journey_get_segment

genesys_journey_get_segments

genesys_journey_get_session

genesys_journey_get_session_events

genesys_journey_get_session_outcomescores

genesys_journey_get_view

genesys_journey_get_view_schedules

genesys_journey_get_view_version

genesys_journey_get_view_version_chart

genesys_journey_get_view_version_chart_version

genesys_journey_get_view_version_job

genesys_journey_get_view_version_job_results

genesys_journey_get_view_version_job_results_chart

genesys_journey_get_view_version_jobs_latest

genesys_journey_get_views

genesys_journey_get_views_data_details

genesys_journey_get_views_eventdefinition

genesys_journey_get_views_eventdefinitions

genesys_journey_get_views_jobs

genesys_journey_get_views_jobs_me

genesys_journey_get_views_schedules

genesys_journey_patch_actionmap

genesys_journey_patch_actiontarget

genesys_journey_patch_actiontemplate

genesys_journey_patch_outcome

genesys_journey_patch_segment

genesys_journey_patch_view_version_job

genesys_journey_post_actionmaps

genesys_journey_post_actionmaps_estimates_jobs

genesys_journey_post_actiontemplates

genesys_journey_post_deployment_actionevent

genesys_journey_post_deployment_appevents

genesys_journey_post_deployment_webevents

genesys_journey_post_flows_paths_query

genesys_journey_post_outcomes

genesys_journey_post_outcomes_predictors

genesys_journey_post_segments

genesys_journey_post_view_schedules

genesys_journey_post_view_version_jobs

genesys_journey_post_view_versions

genesys_journey_post_views

genesys_journey_post_views_encodings_validate

genesys_journey_put_view_schedules

genesys_journey_put_view_version