Sign in
Support channels

Create support channel

Open a new support channel between a company team member and a customer. Returns the existing channel if one already exists for that user.

Required permissions:

  • support_chat:create
post/support_channels

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.

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.

Example response

{
  "custom_name": "Project Alpha Team",
  "customer_user": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  },
  "last_message_at": "2023-12-01T05:00:00.401Z",
  "resolved_at": "2023-12-01T05:00:00.401Z"
}

Changes

Changed in 3 of the 74 revisions of this API.213

  • 8473fa1d1f471See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

  • 697924df40d1211See the full diff
    • ▲

      added the new required request property

      new-required-request-property

    • ▲

      removed the required property from the response with the status

      response-required-property-removed

    • ●

      removed the request property

      request-property-removed

    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6c970f803b461See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.