genesys-social

Genesys Social Media - social topics, escalation rules, and social analytics

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

Tools

Tool	Description
genesys_social_delete_escalationrule	Delete an escalation rule.
genesys_social_delete_topic	Delete a social topic.
genesys_social_get_analytics_aggregates_job	Get status for async query for social media aggregates
genesys_social_get_analytics_aggregates_job_results	Fetch a page of results for an async social media query
genesys_social_get_analytics_messages_job	Get status for async query for social media messages job
genesys_social_get_analytics_messages_job_results	Fetch a page of results for an async social media messages query
genesys_social_get_escalationrule	Get a single escalation rule.
genesys_social_get_escalationrules	Retrieve all escalation rules for a division.
genesys_social_get_topic	Get a single social topic.
genesys_social_get_topic_dataingestionrules	Retrieve all social topic data ingestion rules with pagination.
genesys_social_get_topics	Retrieve all social topics.
genesys_social_patch_topic	Update a social topic.
genesys_social_post_analytics_aggregates_jobs	Query for social media aggregates asynchronously
genesys_social_post_analytics_messages_jobs	Query for social media messages asynchronously
genesys_social_post_escalationrules	Create an escalation rule.
genesys_social_post_escalations_messages	Escalate message to a conversation manually
genesys_social_post_topics	Create a social topic.
genesys_social_put_escalationrule	Update the escalation rule.

---

genesys_social_delete_escalationrule

Delete an escalation rule.

Parameters:

Parameter	Type	Required	Default	Description
escalationRuleId	string	Yes	—	Escalation Rule Id

Show inputSchema

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

---

genesys_social_delete_topic

Delete a social topic.

Parameters:

Parameter	Type	Required	Default	Description
topicId	string	Yes	—	Topic Id
hardDelete	boolean	No	—	Determines whether a Social topic should be soft-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"
    },
    "topicId": {
      "type": "string",
      "description": "Topic Id"
    },
    "hardDelete": {
      "type": "boolean",
      "description": "Determines whether a Social topic should be soft-deleted or hard-deleted (permanently removed). Set to false (soft-delete) by default."
    }
  },
  "required": [
    "PCID",
    "topicId"
  ]
}

---

genesys_social_get_analytics_aggregates_job

Get status for async query for social media aggregates

Parameters:

Parameter	Type	Required	Default	Description
jobId	string	Yes	—	Job Id

Show inputSchema

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

---

genesys_social_get_analytics_aggregates_job_results

Fetch a page of results for an async social media query

Parameters:

Parameter	Type	Required	Default	Description
jobId	string	Yes	—	Job Id
cursor	string	No	—	Cursor token to retrieve next page

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "jobId": {
      "type": "string",
      "description": "Job Id"
    },
    "cursor": {
      "type": "string",
      "description": "Cursor token to retrieve next page"
    }
  },
  "required": [
    "PCID",
    "jobId"
  ]
}

---

genesys_social_get_analytics_messages_job

Get status for async query for social media messages job

Parameters:

Parameter	Type	Required	Default	Description
jobId	string	Yes	—	Job Id

Show inputSchema

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

---

genesys_social_get_analytics_messages_job_results

Fetch a page of results for an async social media messages query

Parameters:

Parameter	Type	Required	Default	Description
jobId	string	Yes	—	Job Id
cursor	string	No	—	Cursor token to retrieve next page

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "jobId": {
      "type": "string",
      "description": "Job Id"
    },
    "cursor": {
      "type": "string",
      "description": "Cursor token to retrieve next page"
    }
  },
  "required": [
    "PCID",
    "jobId"
  ]
}

---

genesys_social_get_escalationrule

Get a single escalation rule.

Parameters:

Parameter	Type	Required	Default	Description
escalationRuleId	string	Yes	—	Escalation Rule Id
expand	string	No	—	which fields, if any, to expand

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "escalationRuleId": {
      "type": "string",
      "description": "Escalation Rule Id"
    },
    "expand": {
      "type": "string",
      "description": "which fields, if any, to expand",
      "enum": [
        "dataIngestionRule"
      ]
    }
  },
  "required": [
    "PCID",
    "escalationRuleId"
  ]
}

---

genesys_social_get_escalationrules

Retrieve all escalation rules for a division.

Parameters:

Parameter	Type	Required	Default	Description
pageNumber	integer	No	—	Page number
pageSize	integer	No	—	Page size
divisionId	string	Yes	—	One division ID

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"
    },
    "divisionId": {
      "type": "string",
      "description": "One division ID"
    }
  },
  "required": [
    "PCID",
    "divisionId"
  ]
}

---

genesys_social_get_topic

Get a single social topic.

Parameters:

Parameter	Type	Required	Default	Description
topicId	string	Yes	—	Topic Id
includeDeleted	boolean	No	—	Determines whether to include soft-deleted items in the result.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "topicId": {
      "type": "string",
      "description": "Topic Id"
    },
    "includeDeleted": {
      "type": "boolean",
      "description": "Determines whether to include soft-deleted items in the result."
    }
  },
  "required": [
    "PCID",
    "topicId"
  ]
}

---

genesys_social_get_topic_dataingestionrules

Retrieve all social topic data ingestion rules with pagination.

Parameters:

Parameter	Type	Required	Default	Description
topicId	string	Yes	—	Topic Id
pageNumber	integer	No	—	Page number
pageSize	integer	No	—	Page size
includeDeleted	boolean	No	—	Determines whether to include soft-deleted items in the result.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "topicId": {
      "type": "string",
      "description": "Topic Id"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    },
    "includeDeleted": {
      "type": "boolean",
      "description": "Determines whether to include soft-deleted items in the result."
    }
  },
  "required": [
    "PCID",
    "topicId"
  ]
}

---

genesys_social_get_topics

Retrieve all social topics.

Parameters:

Parameter	Type	Required	Default	Description
pageNumber	integer	No	—	Page number
pageSize	integer	No	—	Page size
divisionIds	string[]	No	—	One or more division IDs. If nothing is provided, the social topics associated withthe list of divisions that the user has access to will be returned.
includeDeleted	boolean	No	—	Determines whether to include soft-deleted items in the result.
name	string	No	—	Search for topic by name that contains the given search string, search is case insensitive
ids	string[]	No	—	One or more topic IDs to search through the topics.

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"
    },
    "divisionIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "One or more division IDs. If nothing is provided, the social topics associated withthe list of divisions that the user has access to will be returned."
    },
    "includeDeleted": {
      "type": "boolean",
      "description": "Determines whether to include soft-deleted items in the result."
    },
    "name": {
      "type": "string",
      "description": "Search for topic by name that contains the given search string, search is case insensitive"
    },
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "One or more topic IDs to search through the topics."
    }
  },
  "required": [
    "PCID"
  ]
}

---

genesys_social_patch_topic

Update a social topic.

Parameters:

Parameter	Type	Required	Default	Description
topicId	string	Yes	—	Topic Id
description	string	No	—	A description of the social topic.
divisionId	string	No	—	The ID of the division the social topic currently belongs to OR which it should be moved to.
name	string	No	—	Name of the social topic.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "topicId": {
      "type": "string",
      "description": "Topic Id"
    },
    "description": {
      "type": "string",
      "description": "A description of the social topic."
    },
    "divisionId": {
      "type": "string",
      "description": "The ID of the division the social topic currently belongs to OR which it should be moved to."
    },
    "name": {
      "type": "string",
      "description": "Name of the social topic."
    }
  },
  "required": [
    "PCID",
    "topicId"
  ]
}

---

genesys_social_post_analytics_aggregates_jobs

Query for social media aggregates asynchronously

Parameters:

Parameter	Type	Required	Default	Description
filter	object	No	—	The filter value
granularity	string	No	—	Granularity metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
groupBy	string[]	No	—	Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting computations into distinct named subgroups rather than across the entire result set as if it were one group.
interval	string	Yes	—	Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
metrics	string[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
pageSize	integer	No	—	The number of results per page
timeZone	string	No	—	Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "filter": {
      "type": "object",
      "description": "The filter value",
      "properties": {
        "type": {
          "type": "string",
          "description": "Boolean operation to apply to the provided predicates and clauses",
          "enum": [
            "and",
            "or"
          ]
        },
        "clauses": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Boolean 'and/or' logic with up to two-levels of nesting"
        },
        "predicates": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Like a three-word sentence: (attribute-name) (operator) (target-value)."
        }
      },
      "required": [
        "type"
      ]
    },
    "granularity": {
      "type": "string",
      "description": "Granularity metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "groupBy": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "country",
          "language",
          "platform",
          "topic",
          "escalationStatus",
          "messageContentType",
          "sentiment",
          "dataIngestionRule",
          "text",
          "moderationFlag",
          "sourceType",
          "verifiedUser",
          "followerCount",
          "likes",
          "shares",
          "comments",
          "views"
        ]
      },
      "description": "Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting computations into distinct named subgroups rather than across the entire result set as if it were one group."
    },
    "interval": {
      "type": "string",
      "description": "Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "metrics": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "nSocialPosts",
          "oSocialAuthors",
          "oSocialSentiment",
          "oSocialEngagement",
          "nSocialReviewRating"
        ]
      },
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    },
    "pageSize": {
      "type": "integer",
      "description": "The number of results per page"
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    }
  },
  "required": [
    "PCID",
    "interval",
    "metrics"
  ]
}

---

genesys_social_post_analytics_messages_jobs

Query for social media messages asynchronously

Parameters:

Parameter	Type	Required	Default	Description
filter	object	No	—	The filter value
interval	string	Yes	—	Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
order	string	No	—	Deprecated: use ‘sort’ field instead. Sorting of results based on time
pageSize	integer	No	—	The number of results per page
timeZone	string	No	—	Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "filter": {
      "type": "object",
      "description": "The filter value",
      "properties": {
        "type": {
          "type": "string",
          "description": "Boolean operation to apply to the provided predicates and clauses",
          "enum": [
            "and",
            "or"
          ]
        },
        "clauses": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Boolean 'and/or' logic with up to two-levels of nesting"
        },
        "predicates": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Like a three-word sentence: (attribute-name) (operator) (target-value)."
        }
      },
      "required": [
        "type"
      ]
    },
    "interval": {
      "type": "string",
      "description": "Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "order": {
      "type": "string",
      "description": "Deprecated: use 'sort' field instead. Sorting of results based on time",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "pageSize": {
      "type": "integer",
      "description": "The number of results per page"
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    }
  },
  "required": [
    "PCID",
    "interval"
  ]
}

---

genesys_social_post_escalationrules

Create an escalation rule.

Parameters:

Parameter	Type	Required	Default	Description
description	string	No	—	A description of the social escalation rule.
divisionId	string	Yes	—	The ID of the division the social escalation rule belongs to.
facebookEscalation	object	No	—	Facebook Escalation
googleBusinessProfileEscalation	object	No	—	Google Business Profile Escalation
instagramEscalation	object	No	—	Instagram Escalation
matchCriteria	string	Yes	—	The criteria that defines when a social media message should be escalated.
name	string	Yes	—	The name of the escalation rule.
openEscalation	object	No	—	Open Escalation
priority	integer	Yes	—	The priority of the escalation rule. The lower the number the higer the priority. Once a rule is matched others are skipped.
status	string	No	—	The status of the escalation rule.
twitterEscalation	object	No	—	Twitter Escalation

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "description": {
      "type": "string",
      "description": "A description of the social escalation rule."
    },
    "divisionId": {
      "type": "string",
      "description": "The ID of the division the social escalation rule belongs to."
    },
    "facebookEscalation": {
      "type": "object",
      "description": "Facebook Escalation",
      "properties": {
        "targetType": {
          "type": "string",
          "description": "Defines the target that the message will be escalated to.",
          "enum": [
            "Conversation"
          ]
        },
        "destination": {
          "type": "string",
          "description": "Defines the destination of the escalation.SourceIntegration means use the SocialMedia Source Integration as the destination.OverrideIntegration means the set integration will be used regardless of the source.",
          "enum": [
            "SourceIntegration",
            "OverrideIntegration"
          ]
        },
        "override": {
          "type": "object",
          "description": "The override value"
        }
      },
      "required": [
        "destination",
        "targetType"
      ]
    },
    "googleBusinessProfileEscalation": {
      "type": "object",
      "description": "Google Business Profile Escalation",
      "properties": {
        "targetType": {
          "type": "string",
          "description": "Defines the target that the message will be escalated to.",
          "enum": [
            "Conversation"
          ]
        },
        "destination": {
          "type": "string",
          "description": "Defines the destination of the escalation.SourceIntegration means use the SocialMedia Source Integration as the destination.OverrideIntegration means the set integration will be used regardless of the source.",
          "enum": [
            "SourceIntegration",
            "OverrideIntegration"
          ]
        },
        "override": {
          "type": "object",
          "description": "The override value"
        }
      },
      "required": [
        "destination",
        "targetType"
      ]
    },
    "instagramEscalation": {
      "type": "object",
      "description": "Instagram Escalation",
      "properties": {
        "targetType": {
          "type": "string",
          "description": "Defines the target that the message will be escalated to.",
          "enum": [
            "Conversation"
          ]
        },
        "destination": {
          "type": "string",
          "description": "Defines the destination of the escalation.SourceIntegration means use the SocialMedia Source Integration as the destination.OverrideIntegration means the set integration will be used regardless of the source.",
          "enum": [
            "SourceIntegration",
            "OverrideIntegration"
          ]
        },
        "override": {
          "type": "object",
          "description": "The override value"
        }
      },
      "required": [
        "destination",
        "targetType"
      ]
    },
    "matchCriteria": {
      "type": "string",
      "description": "The criteria that defines when a social media message should be escalated."
    },
    "name": {
      "type": "string",
      "description": "The name of the escalation rule."
    },
    "openEscalation": {
      "type": "object",
      "description": "Open Escalation",
      "properties": {
        "targetType": {
          "type": "string",
          "description": "Defines the target that the message will be escalated to.",
          "enum": [
            "Conversation"
          ]
        },
        "destination": {
          "type": "string",
          "description": "Defines the destination of the escalation.SourceIntegration means use the SocialMedia Source Integration as the destination.OverrideIntegration means the set integration will be used regardless of the source.",
          "enum": [
            "SourceIntegration",
            "OverrideIntegration"
          ]
        },
        "override": {
          "type": "object",
          "description": "The override value"
        }
      },
      "required": [
        "destination",
        "targetType"
      ]
    },
    "priority": {
      "type": "integer",
      "description": "The priority of the escalation rule. The lower the number the higer the priority. Once a rule is matched others are skipped."
    },
    "status": {
      "type": "string",
      "description": "The status of the escalation rule.",
      "enum": [
        "Active",
        "Paused"
      ]
    },
    "twitterEscalation": {
      "type": "object",
      "description": "Twitter Escalation",
      "properties": {
        "targetType": {
          "type": "string",
          "description": "Defines the target that the message will be escalated to.",
          "enum": [
            "Conversation"
          ]
        },
        "destination": {
          "type": "string",
          "description": "Defines the destination of the escalation.SourceIntegration means use the SocialMedia Source Integration as the destination.OverrideIntegration means the set integration will be used regardless of the source.",
          "enum": [
            "SourceIntegration",
            "OverrideIntegration"
          ]
        },
        "override": {
          "type": "object",
          "description": "The override value"
        }
      },
      "required": [
        "destination",
        "targetType"
      ]
    }
  },
  "required": [
    "PCID",
    "divisionId",
    "matchCriteria",
    "name",
    "priority"
  ]
}

---

genesys_social_post_escalations_messages

Escalate message to a conversation manually

Parameters:

Parameter	Type	Required	Default	Description
divisionId	string	Yes	—	One division ID
escalationTarget	object	No	—	Escalation Target
socialMediaNormalizedMessageId	string	Yes	—	The social media normalized message ID to be escalated.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "divisionId": {
      "type": "string",
      "description": "One division ID"
    },
    "escalationTarget": {
      "type": "object",
      "description": "Escalation Target",
      "properties": {
        "targetType": {
          "type": "string",
          "description": "Defines the target that the message will be escalated to.",
          "enum": [
            "Conversation"
          ]
        },
        "destination": {
          "type": "string",
          "description": "Defines the destination of the escalation.SourceIntegration means use the SocialMedia Source Integration as the destination.OverrideIntegration means the set integration will be used regardless of the source.",
          "enum": [
            "SourceIntegration",
            "OverrideIntegration"
          ]
        },
        "override": {
          "type": "object",
          "description": "The override value"
        }
      },
      "required": [
        "destination",
        "targetType"
      ]
    },
    "socialMediaNormalizedMessageId": {
      "type": "string",
      "description": "The social media normalized message ID to be escalated."
    }
  },
  "required": [
    "PCID",
    "divisionId",
    "socialMediaNormalizedMessageId"
  ]
}

---

genesys_social_post_topics

Create a social topic.

Parameters:

Parameter	Type	Required	Default	Description
description	string	No	—	A description of the social topic.
divisionId	string	Yes	—	The ID of the division the social topic belongs to.
name	string	Yes	—	Name of the social topic.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "description": {
      "type": "string",
      "description": "A description of the social topic."
    },
    "divisionId": {
      "type": "string",
      "description": "The ID of the division the social topic belongs to."
    },
    "name": {
      "type": "string",
      "description": "Name of the social topic."
    }
  },
  "required": [
    "PCID",
    "divisionId",
    "name"
  ]
}

---

genesys_social_put_escalationrule

Update the escalation rule.

Parameters:

Parameter	Type	Required	Default	Description
escalationRuleId	string	Yes	—	Escalation Rule Id
description	string	No	—	A description of the social escalation rule.
divisionId	string	Yes	—	The ID of the division the social escalation rule belongs to.
facebookEscalation	object	No	—	Facebook Escalation
googleBusinessProfileEscalation	object	No	—	Google Business Profile Escalation
instagramEscalation	object	No	—	Instagram Escalation
matchCriteria	string	Yes	—	The criteria that defines when a social media message should be escalated.
name	string	Yes	—	The name of the escalation rule.
openEscalation	object	No	—	Open Escalation
priority	integer	Yes	—	The priority of the escalation rule. The lower the number the higer the priority. Once a rule is matched others are skipped.
status	string	No	—	The status of the escalation rule.
twitterEscalation	object	No	—	Twitter Escalation

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "escalationRuleId": {
      "type": "string",
      "description": "Escalation Rule Id"
    },
    "description": {
      "type": "string",
      "description": "A description of the social escalation rule."
    },
    "divisionId": {
      "type": "string",
      "description": "The ID of the division the social escalation rule belongs to."
    },
    "facebookEscalation": {
      "type": "object",
      "description": "Facebook Escalation",
      "properties": {
        "targetType": {
          "type": "string",
          "description": "Defines the target that the message will be escalated to.",
          "enum": [
            "Conversation"
          ]
        },
        "destination": {
          "type": "string",
          "description": "Defines the destination of the escalation.SourceIntegration means use the SocialMedia Source Integration as the destination.OverrideIntegration means the set integration will be used regardless of the source.",
          "enum": [
            "SourceIntegration",
            "OverrideIntegration"
          ]
        },
        "override": {
          "type": "object",
          "description": "The override value"
        }
      },
      "required": [
        "destination",
        "targetType"
      ]
    },
    "googleBusinessProfileEscalation": {
      "type": "object",
      "description": "Google Business Profile Escalation",
      "properties": {
        "targetType": {
          "type": "string",
          "description": "Defines the target that the message will be escalated to.",
          "enum": [
            "Conversation"
          ]
        },
        "destination": {
          "type": "string",
          "description": "Defines the destination of the escalation.SourceIntegration means use the SocialMedia Source Integration as the destination.OverrideIntegration means the set integration will be used regardless of the source.",
          "enum": [
            "SourceIntegration",
            "OverrideIntegration"
          ]
        },
        "override": {
          "type": "object",
          "description": "The override value"
        }
      },
      "required": [
        "destination",
        "targetType"
      ]
    },
    "instagramEscalation": {
      "type": "object",
      "description": "Instagram Escalation",
      "properties": {
        "targetType": {
          "type": "string",
          "description": "Defines the target that the message will be escalated to.",
          "enum": [
            "Conversation"
          ]
        },
        "destination": {
          "type": "string",
          "description": "Defines the destination of the escalation.SourceIntegration means use the SocialMedia Source Integration as the destination.OverrideIntegration means the set integration will be used regardless of the source.",
          "enum": [
            "SourceIntegration",
            "OverrideIntegration"
          ]
        },
        "override": {
          "type": "object",
          "description": "The override value"
        }
      },
      "required": [
        "destination",
        "targetType"
      ]
    },
    "matchCriteria": {
      "type": "string",
      "description": "The criteria that defines when a social media message should be escalated."
    },
    "name": {
      "type": "string",
      "description": "The name of the escalation rule."
    },
    "openEscalation": {
      "type": "object",
      "description": "Open Escalation",
      "properties": {
        "targetType": {
          "type": "string",
          "description": "Defines the target that the message will be escalated to.",
          "enum": [
            "Conversation"
          ]
        },
        "destination": {
          "type": "string",
          "description": "Defines the destination of the escalation.SourceIntegration means use the SocialMedia Source Integration as the destination.OverrideIntegration means the set integration will be used regardless of the source.",
          "enum": [
            "SourceIntegration",
            "OverrideIntegration"
          ]
        },
        "override": {
          "type": "object",
          "description": "The override value"
        }
      },
      "required": [
        "destination",
        "targetType"
      ]
    },
    "priority": {
      "type": "integer",
      "description": "The priority of the escalation rule. The lower the number the higer the priority. Once a rule is matched others are skipped."
    },
    "status": {
      "type": "string",
      "description": "The status of the escalation rule.",
      "enum": [
        "Active",
        "Paused"
      ]
    },
    "twitterEscalation": {
      "type": "object",
      "description": "Twitter Escalation",
      "properties": {
        "targetType": {
          "type": "string",
          "description": "Defines the target that the message will be escalated to.",
          "enum": [
            "Conversation"
          ]
        },
        "destination": {
          "type": "string",
          "description": "Defines the destination of the escalation.SourceIntegration means use the SocialMedia Source Integration as the destination.OverrideIntegration means the set integration will be used regardless of the source.",
          "enum": [
            "SourceIntegration",
            "OverrideIntegration"
          ]
        },
        "override": {
          "type": "object",
          "description": "The override value"
        }
      },
      "required": [
        "destination",
        "targetType"
      ]
    }
  },
  "required": [
    "PCID",
    "escalationRuleId",
    "divisionId",
    "matchCriteria",
    "name",
    "priority"
  ]
}