Support channels

Create support channel

Changed on

Opens a support channel between an account's team and a customer. Returns the existing channel if that customer already has one.

Required permissions:

  • support_chat:create
post/support_channels

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/support_channels
  • Auth: HTTP bearer

Request body

account_idstring required

The unique identifier of the company to create the support channel in.

custom_namestring nullable

Optional custom display name for the support channel.

notifications_enabledboolean nullable

Whether Whop app notifications are enabled for this support channel. Webhooks still fire.

user_idstring required

The user ID (e.g. 'user_xxxxx') or username of the customer to open a support channel for.

Example request

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "user_id": "user_xxxxxxxxxxxxx"
}

Response

A successful response

account_idstring nullable required

The unique identifier of the account associated with this channel. Null if this is not a support or account-scoped conversation.

company_idstring nullable required

The unique identifier of the account associated with this channel. Null if this is not a support or account-scoped conversation.

custom_namestring nullable required

A custom display name assigned to this channel by the user. Null if no custom name has been set.

idstring required

The unique identifier for the entity

last_message_atstring date-time nullable required

The timestamp when the most recent message was sent in this channel. Null if no messages have been sent.

needs_replyboolean nullable required

Whether the customer sent the latest message and the linked support ticket is unresolved. Null if not a support chat.

participatedboolean nullable required

Whether the authenticated user has joined this channel as a participant. Null when the caller is not a user, or when listing support channels without include_participated.

resolved_atstring date-time nullable required

The timestamp when the linked support ticket was marked as resolved. Null if unresolved or not a support chat.

unreadboolean nullable required

Whether this channel has a message from someone else that the authenticated user has not viewed yet. Null when the caller is not a user, or when listing support channels without include_last_message.

Example response

{
  "custom_name": "Project Alpha Team",
  "customer_user": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  },
  "last_message": {
    "attachments": [
      {
        "content_type": "image/jpeg",
        "filename": "document.pdf"
      }
    ],
    "content": "Hey, are you available for a **quick call**?",
    "created_at": "2023-12-01T05:00:00.401Z"
  },
  "last_message_at": "2023-12-01T05:00:00.401Z",
  "resolved_at": "2023-12-01T05:00:00.401Z"
}

Changes

  • 507636677fe9Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 8473fa1d1f47Revision changes
    • info

      added the required property to the response with the status