superchat

Server path: /superchat | Type: Application | PCID required: Yes

Tools

Tool	Description
`superchat_create_contact`	Create a contact
`superchat_create_template_folder`	Create a template folder
`superchat_create_webhook`	Create a webhook
`superchat_delete_webhook`	Delete a webhook
`superchat_get_channel`	Get a channel
`superchat_get_contact`	Get a contact
`superchat_get_conversation`	Get a conversation
`superchat_get_file`	Get a file
`superchat_get_user`	Get a user
`superchat_list_channels`	List all channels
`superchat_list_contact_conversations`	List conversations for a contact
`superchat_list_contacts`	List all contacts
`superchat_list_conversations`	List all conversations
`superchat_list_inboxes`	List all inboxes
`superchat_list_labels`	List all labels
`superchat_list_templates`	List all templates
`superchat_list_users`	List all users
`superchat_list_webhooks`	List all webhooks
`superchat_send_message`	Send a message
`superchat_update_contact`	Update a contact
`superchat_update_webhook`	Update a webhook

superchat_create_contact

Create a contact Parameters:

Parameter	Type	Required	Default	Description
`custom_attributes`	object[]	No	—	Custom contact attributes. Supported types: date_time, date_only, string, number, multi_select, single_select.
`first_name`	string	No	—	The contact’s given name.
`gender`	string	No	—	The contact’s gender.
`handles`	object[]	No	—	Contact handles (phone, email, etc.) linked to this contact.
`last_name`	string	No	—	The contact’s surname.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "custom_attributes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The attribute name."
          },
          "value": {
            "type": "string",
            "description": "The attribute value."
          }
        }
      },
      "description": "Custom contact attributes. Supported types: date_time, date_only, string, number, multi_select, single_select."
    },
    "first_name": {
      "type": "string",
      "description": "The contact's given name."
    },
    "gender": {
      "type": "string",
      "description": "The contact's gender.",
      "enum": [
        "female",
        "male",
        "diverse"
      ]
    },
    "handles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "The handle type (e.g., phone, email)."
          },
          "value": {
            "type": "string",
            "description": "The handle value (e.g., phone number in E164 format, email address)."
          }
        }
      },
      "description": "Contact handles (phone, email, etc.) linked to this contact."
    },
    "last_name": {
      "type": "string",
      "description": "The contact's surname."
    }
  },
  "required": [
    "PCID"
  ]
}

superchat_create_template_folder

Create a template folder Parameters:

Parameter	Type	Required	Default	Description
`name`	string	Yes	—	The name of the template folder.
`parent_id`	string	No	—	Unique identifier of the parent template folder. Always bears prefix ‘tn_’.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "name": {
      "type": "string",
      "description": "The name of the template folder."
    },
    "parent_id": {
      "type": "string",
      "description": "Unique identifier of the parent template folder. Always bears prefix 'tn_'."
    }
  },
  "required": [
    "PCID",
    "name"
  ]
}

superchat_create_webhook

Create a webhook Parameters:

Parameter	Type	Required	Default	Description
`events`	object[]	Yes	—	Events that trigger the webhook.
`target_url`	string	Yes	—	The target URL for the webhook. Must use https://.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "The event type."
          }
        }
      },
      "description": "Events that trigger the webhook."
    },
    "target_url": {
      "type": "string",
      "description": "The target URL for the webhook. Must use https://."
    }
  },
  "required": [
    "PCID",
    "events",
    "target_url"
  ]
}

superchat_delete_webhook

Delete a webhook Parameters:

Parameter	Type	Required	Default	Description
`webhook_id`	string	Yes	—	The unique identifier of the webhook.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "webhook_id": {
      "type": "string",
      "description": "The unique identifier of the webhook."
    }
  },
  "required": [
    "PCID",
    "webhook_id"
  ]
}

superchat_get_channel

Get a channel Parameters:

Parameter	Type	Required	Default	Description
`channel_id`	string	Yes	—	Unique identifier of the channel, prefixed with ‘mc_’.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "channel_id": {
      "type": "string",
      "description": "Unique identifier of the channel, prefixed with 'mc_'."
    }
  },
  "required": [
    "PCID",
    "channel_id"
  ]
}

superchat_get_contact

Get a contact Parameters:

Parameter	Type	Required	Default	Description
`contact_id`	string	Yes	—	The unique identifier of the contact.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contact_id": {
      "type": "string",
      "description": "The unique identifier of the contact."
    }
  },
  "required": [
    "PCID",
    "contact_id"
  ]
}

superchat_get_conversation

Get a conversation Parameters:

Parameter	Type	Required	Default	Description
`conversation_id`	string	Yes	—	The unique identifier of the conversation.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversation_id": {
      "type": "string",
      "description": "The unique identifier of the conversation."
    }
  },
  "required": [
    "PCID",
    "conversation_id"
  ]
}

superchat_get_file

Get a file Parameters:

Parameter	Type	Required	Default	Description
`file_id`	string	Yes	—	The unique identifier of the file.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "file_id": {
      "type": "string",
      "description": "The unique identifier of the file."
    }
  },
  "required": [
    "PCID",
    "file_id"
  ]
}

superchat_get_user

Get a user Parameters:

Parameter	Type	Required	Default	Description
`user_id`	string	Yes	—	The unique identifier of the user.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "user_id": {
      "type": "string",
      "description": "The unique identifier of the user."
    }
  },
  "required": [
    "PCID",
    "user_id"
  ]
}

superchat_list_channels

List all channels Parameters:

Parameter	Type	Required	Default	Description
`limit`	integer	No	—	The total number of objects to be returned. Allowed range: 1-100. Defaults to 50.
`after`	string	No	—	Cursor for pagination. Specify the cursor after which objects should be returned.
`before`	string	No	—	Cursor for pagination. Specify the cursor before which objects should be returned.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "The total number of objects to be returned. Allowed range: 1-100. Defaults to 50."
    },
    "after": {
      "type": "string",
      "description": "Cursor for pagination. Specify the cursor after which objects should be returned."
    },
    "before": {
      "type": "string",
      "description": "Cursor for pagination. Specify the cursor before which objects should be returned."
    }
  },
  "required": [
    "PCID"
  ]
}

superchat_list_contact_conversations

List conversations for a contact Parameters:

Parameter	Type	Required	Default	Description
`contact_id`	string	Yes	—	The unique identifier of the contact.
`limit`	integer	No	—	The total number of objects to be returned.
`after`	string	No	—	Cursor for pagination.
`before`	string	No	—	Cursor for pagination.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contact_id": {
      "type": "string",
      "description": "The unique identifier of the contact."
    },
    "limit": {
      "type": "integer",
      "description": "The total number of objects to be returned."
    },
    "after": {
      "type": "string",
      "description": "Cursor for pagination."
    },
    "before": {
      "type": "string",
      "description": "Cursor for pagination."
    }
  },
  "required": [
    "PCID",
    "contact_id"
  ]
}

superchat_list_contacts

List all contacts Parameters:

Parameter	Type	Required	Default	Description
`limit`	integer	No	—	The total number of objects to be returned. Allowed range: 1-100. Defaults to 50.
`after`	string	No	—	Cursor for pagination. Specify the cursor after which objects should be returned.
`before`	string	No	—	Cursor for pagination. Specify the cursor before which objects should be returned.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "The total number of objects to be returned. Allowed range: 1-100. Defaults to 50."
    },
    "after": {
      "type": "string",
      "description": "Cursor for pagination. Specify the cursor after which objects should be returned."
    },
    "before": {
      "type": "string",
      "description": "Cursor for pagination. Specify the cursor before which objects should be returned."
    }
  },
  "required": [
    "PCID"
  ]
}

superchat_list_conversations

List all conversations Parameters:

Parameter	Type	Required	Default	Description
`limit`	integer	No	—	The total number of objects to be returned.
`after`	string	No	—	Cursor for pagination.
`before`	string	No	—	Cursor for pagination.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "The total number of objects to be returned."
    },
    "after": {
      "type": "string",
      "description": "Cursor for pagination."
    },
    "before": {
      "type": "string",
      "description": "Cursor for pagination."
    }
  },
  "required": [
    "PCID"
  ]
}

superchat_list_inboxes

List all inboxes Parameters:

Parameter	Type	Required	Default	Description
`limit`	integer	No	—	The total number of objects to be returned.
`after`	string	No	—	Cursor for pagination.
`before`	string	No	—	Cursor for pagination.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "The total number of objects to be returned."
    },
    "after": {
      "type": "string",
      "description": "Cursor for pagination."
    },
    "before": {
      "type": "string",
      "description": "Cursor for pagination."
    }
  },
  "required": [
    "PCID"
  ]
}

superchat_list_labels

List all labels Parameters:

Parameter	Type	Required	Default	Description
`limit`	integer	No	—	The total number of objects to be returned.
`after`	string	No	—	Cursor for pagination.
`before`	string	No	—	Cursor for pagination.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "The total number of objects to be returned."
    },
    "after": {
      "type": "string",
      "description": "Cursor for pagination."
    },
    "before": {
      "type": "string",
      "description": "Cursor for pagination."
    }
  },
  "required": [
    "PCID"
  ]
}

superchat_list_templates

List all templates Parameters:

Parameter	Type	Required	Default	Description
`limit`	integer	No	—	The total number of objects to be returned.
`after`	string	No	—	Cursor for pagination.
`before`	string	No	—	Cursor for pagination.
`channel_id`	string	No	—	Filter by channel ID. Always starts with prefix ‘mc_’.
`folder_id`	string	No	—	Filter by template folder ID. Always starts with prefix ‘tn_’.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "The total number of objects to be returned."
    },
    "after": {
      "type": "string",
      "description": "Cursor for pagination."
    },
    "before": {
      "type": "string",
      "description": "Cursor for pagination."
    },
    "channel_id": {
      "type": "string",
      "description": "Filter by channel ID. Always starts with prefix 'mc_'."
    },
    "folder_id": {
      "type": "string",
      "description": "Filter by template folder ID. Always starts with prefix 'tn_'."
    }
  },
  "required": [
    "PCID"
  ]
}

superchat_list_users

List all users Parameters:

Parameter	Type	Required	Default	Description
`limit`	integer	No	—	The total number of objects to be returned.
`after`	string	No	—	Cursor for pagination.
`before`	string	No	—	Cursor for pagination.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "The total number of objects to be returned."
    },
    "after": {
      "type": "string",
      "description": "Cursor for pagination."
    },
    "before": {
      "type": "string",
      "description": "Cursor for pagination."
    }
  },
  "required": [
    "PCID"
  ]
}

superchat_list_webhooks

List all webhooks Parameters:

Parameter	Type	Required	Default	Description
`limit`	integer	No	—	The total number of objects to be returned.
`after`	string	No	—	Cursor for pagination.
`before`	string	No	—	Cursor for pagination.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "The total number of objects to be returned."
    },
    "after": {
      "type": "string",
      "description": "Cursor for pagination."
    },
    "before": {
      "type": "string",
      "description": "Cursor for pagination."
    }
  },
  "required": [
    "PCID"
  ]
}

superchat_send_message

Send a message Parameters:

Parameter	Type	Required	Default	Description
`content`	object	Yes	—	Message content. Supports types: text, media, whats_app_template, whats_app_quick_reply, whats_app_list, email, live_chat_buttons.
`from`	object	Yes	—	The channel to send the message from.
`in_reply_to`	string	null	No	—	Message ID for reply threading (email only).
`to`	object[]	Yes	—	Array of recipients (length 1). Each recipient has an identifier (email, phone in E164 format, or contact_id).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "content": {
      "type": "object",
      "description": "Message content. Supports types: text, media, whats_app_template, whats_app_quick_reply, whats_app_list, email, live_chat_buttons.",
      "properties": {
        "type": {
          "type": "string",
          "description": "The content type.",
          "enum": [
            "text",
            "media",
            "whats_app_template",
            "whats_app_quick_reply",
            "whats_app_list",
            "email",
            "live_chat_buttons"
          ]
        },
        "body": {
          "type": "string",
          "description": "The message body text."
        },
        "media_url": {
          "type": "string",
          "description": "URL of the media to send (for media type)."
        },
        "subject": {
          "type": "string",
          "description": "Email subject (for email type)."
        }
      }
    },
    "from": {
      "type": "object",
      "description": "The channel to send the message from.",
      "properties": {
        "channel_id": {
          "type": "string",
          "description": "The channel ID (prefixed with 'mc_')."
        }
      }
    },
    "in_reply_to": {
      "type": [
        "string",
        "null"
      ],
      "description": "Message ID for reply threading (email only)."
    },
    "to": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "identifier": {
            "type": "string",
            "description": "Email, phone number (E164 format), or contact_id."
          }
        },
        "required": [
          "identifier"
        ]
      },
      "description": "Array of recipients (length 1). Each recipient has an identifier (email, phone in E164 format, or contact_id)."
    }
  },
  "required": [
    "PCID",
    "content",
    "from",
    "to"
  ]
}

superchat_update_contact

Update a contact Parameters:

Parameter	Type	Required	Default	Description
`contact_id`	string	Yes	—	The unique identifier of the contact.
`custom_attributes`	object[]	No	—	Custom contact attributes.
`first_name`	string	No	—	The contact’s given name.
`gender`	string	No	—	The contact’s gender.
`handles`	object[]	No	—	Contact handles for phone and email only.
`last_name`	string	No	—	The contact’s surname.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contact_id": {
      "type": "string",
      "description": "The unique identifier of the contact."
    },
    "custom_attributes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The attribute name."
          },
          "value": {
            "type": "string",
            "description": "The attribute value."
          }
        }
      },
      "description": "Custom contact attributes."
    },
    "first_name": {
      "type": "string",
      "description": "The contact's given name."
    },
    "gender": {
      "type": "string",
      "description": "The contact's gender.",
      "enum": [
        "female",
        "male",
        "diverse"
      ]
    },
    "handles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "The handle type (e.g., phone, email)."
          },
          "value": {
            "type": "string",
            "description": "The handle value."
          }
        }
      },
      "description": "Contact handles for phone and email only."
    },
    "last_name": {
      "type": "string",
      "description": "The contact's surname."
    }
  },
  "required": [
    "PCID",
    "contact_id"
  ]
}

superchat_update_webhook

Update a webhook Parameters:

Parameter	Type	Required	Default	Description
`webhook_id`	string	Yes	—	The unique identifier of the webhook.
`events`	object[]	Yes	—	Events that trigger the webhook.
`target_url`	string	Yes	—	The target URL for the webhook. Must use https://.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "webhook_id": {
      "type": "string",
      "description": "The unique identifier of the webhook."
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "The event type."
          }
        }
      },
      "description": "Events that trigger the webhook."
    },
    "target_url": {
      "type": "string",
      "description": "The target URL for the webhook. Must use https://."
    }
  },
  "required": [
    "PCID",
    "webhook_id",
    "events",
    "target_url"
  ]
}

Platform API

Embedded MCP Servers

Application MCP Servers

Triggers API

Tools

superchat_create_contact

superchat_create_template_folder

superchat_create_webhook

superchat_delete_webhook

superchat_get_channel

superchat_get_contact

superchat_get_conversation

superchat_get_file

superchat_get_user

superchat_list_channels

superchat_list_contact_conversations

superchat_list_contacts

superchat_list_conversations

superchat_list_inboxes

superchat_list_labels

superchat_list_templates

superchat_list_users

superchat_list_webhooks

superchat_send_message

superchat_update_contact

superchat_update_webhook

​Tools

​superchat_create_contact

​superchat_create_template_folder

​superchat_create_webhook

​superchat_delete_webhook

​superchat_get_channel

​superchat_get_contact

​superchat_get_conversation

​superchat_get_file

​superchat_get_user

​superchat_list_channels

​superchat_list_contact_conversations

​superchat_list_contacts

​superchat_list_conversations

​superchat_list_inboxes

​superchat_list_labels

​superchat_list_templates

​superchat_list_users

​superchat_list_webhooks

​superchat_send_message

​superchat_update_contact

​superchat_update_webhook

Tools

superchat_create_contact

superchat_create_template_folder

superchat_create_webhook

superchat_delete_webhook

superchat_get_channel

superchat_get_contact

superchat_get_conversation

superchat_get_file

superchat_get_user

superchat_list_channels

superchat_list_contact_conversations

superchat_list_contacts

superchat_list_conversations

superchat_list_inboxes

superchat_list_labels

superchat_list_templates

superchat_list_users

superchat_list_webhooks

superchat_send_message

superchat_update_contact

superchat_update_webhook