Skip to content
This repository has been archived by the owner on Jun 27, 2024. It is now read-only.

Latest commit

 

History

History
63 lines (49 loc) · 1.66 KB

convert-team-to-channel.md

File metadata and controls

63 lines (49 loc) · 1.66 KB

Convert Team to Channel

HTTP MethodURLRequires Auth
POSTapi/v1/teams.convertToChannelyes

Body Parameters

KeyExample ValueDescription
teamId*612b8ae982d286c3d1f5The team ID that you want to convert to a channel.

Example Call

curl --location --request POST 'http://localhost:3000/api/v1/teams.convertToChannel\
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name' \
-d "teamId=612b8ae982d286c3d1f5db31"

Example Response

Success

{
    "success": true
}

Errors

The following error can occur:

  • Authorization: Requires an authentication token for the request to be made.
  • Missing Team ID or Name: Requires a valid Team ID or Name for the request to be made.
  • Invalid Team ID: Requires a valid Team ID for the request to be made.

{% tabs %} {% tab title=" Authorization" %}

{
    "status": "error",
    "message": "You must be logged in to do this."
}

{% endtab %}

{% tab title="Missing Team ID or Name" %}

{
    "success": false,
    "error": "missing-teamId-or-teamName"
}

{% endtab %}

{% tab title="Invalid Team ID" %}

{
    "success": false,
    "error": "team-does-not-exist"
}

{% endtab %} {% endtabs %}