mirror of
https://github.com/Bayselonarrend/OpenIntegrations.git
synced 2024-12-23 02:06:12 +02:00
87 lines
1.8 KiB
Markdown
87 lines
1.8 KiB
Markdown
---
|
|
sidebar_position: 12
|
|
---
|
|
|
|
# Set channel purpose
|
|
Sets the channel purpose (description)
|
|
|
|
|
|
*Function SetChannelGoal(Val Token, Val Channel, Val Purpose) Export*
|
|
|
|
| Parameter | CLI option | Type | Destination |
|
|
|-|-|-|-|
|
|
| Token | --token | String | Bot token |
|
|
| Channel | --channel | String | Channel ID |
|
|
| Purpose | --purpose | String | Channel purpose |
|
|
|
|
|
|
Returns: Key-Value Pair - Serialized JSON response from Slack
|
|
|
|
```bsl title="Code example"
|
|
|
|
|
|
Purpose = "TestGoal";
|
|
Channel = "C070VPMKN8J";
|
|
|
|
Response = OPI_Slack.SetChannelGoal(Token, Channel, Purpose); //Map
|
|
Response = OPI_Tools.JSONString(Response); //JSON string
|
|
|
|
|
|
|
|
```
|
|
|
|
```sh title="CLI command example"
|
|
|
|
oint slack SetChannelGoal --token %token% --channel "C070VPMKN8J" --purpose "TestGoal"
|
|
|
|
|
|
```
|
|
|
|
|
|
```json title="Result"
|
|
|
|
{
|
|
"ok": true,
|
|
"channel": {
|
|
"id": "C070VPMKN8J",
|
|
"name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c",
|
|
"is_channel": true,
|
|
"is_group": false,
|
|
"is_im": false,
|
|
"is_mpim": false,
|
|
"is_private": false,
|
|
"created": 1714146542,
|
|
"is_archived": false,
|
|
"is_general": false,
|
|
"unlinked": 0,
|
|
"name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c",
|
|
"is_shared": false,
|
|
"is_org_shared": false,
|
|
"is_pending_ext_shared": false,
|
|
"pending_shared": [],
|
|
"context_team_id": "T06UD92BS3C",
|
|
"updated": 1714146542983,
|
|
"parent_conversation": null,
|
|
"creator": "U06UG1CAYH2",
|
|
"is_ext_shared": false,
|
|
"shared_team_ids": [
|
|
"T06UD92BS3C"
|
|
],
|
|
"pending_connected_team_ids": [],
|
|
"is_member": false,
|
|
"topic": {
|
|
"value": "TestTopic",
|
|
"creator": "U06UG1CAYH2",
|
|
"last_set": 1714146542
|
|
},
|
|
"purpose": {
|
|
"value": "TestGoal",
|
|
"creator": "U06UG1CAYH2",
|
|
"last_set": 1714146542
|
|
},
|
|
"previous_names": []
|
|
}
|
|
}
|
|
|
|
```
|