Skip to content

feat: add channel_id and optional document_content to canvases.create #2001

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zimeg merged 2 commits into from
Oct 28, 2026
Merged

feat: add channel_id and optional document_content to canvases.create #2001

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a6b29d
feat: add channel_id and optional document_content to canvases.create
zimeg Oct 28, 2026
6f92af1
Merge branch 'main' into clack/canvases-create-args
zimeg Oct 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions slack_sdk/web/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2855,14 +2855,22 @@ async def canvases_create(
self,
*,
title: Optional[str] = None,
document_content: Dict[str, str],
document_content: Optional[Dict[str, str]] = None,
channel_id: Optional[str] = None,
**kwargs,
) -> AsyncSlackResponse:
"""Create Canvas for a user.

https://docs.slack.dev/reference/methods/canvases.create
"""
kwargs.update({"title": title, "document_content": document_content})
kwargs.update(
{
"title": title,
"document_content": document_content,
"channel_id": channel_id,
}
)
kwargs = _remove_none_values(kwargs)
return await self.api_call("canvases.create", json=kwargs)

async def canvases_edit(
Expand Down
12 changes: 10 additions & 2 deletions slack_sdk/web/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2845,14 +2845,22 @@ def canvases_create(
self,
*,
title: Optional[str] = None,
document_content: Dict[str, str],
document_content: Optional[Dict[str, str]] = None,
channel_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
"""Create Canvas for a user.

https://docs.slack.dev/reference/methods/canvases.create
"""
kwargs.update({"title": title, "document_content": document_content})
kwargs.update(
{
"title": title,
"document_content": document_content,
"channel_id": channel_id,
}
)
kwargs = _remove_none_values(kwargs)

@mwbrooks mwbrooks Oct 28, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

praise: Thanks for dropping the None values! title=None was going out as null in the JSON body before this.

return self.api_call("canvases.create", json=kwargs)

def canvases_edit(
Expand Down
12 changes: 10 additions & 2 deletions slack_sdk/web/legacy_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2856,14 +2856,22 @@ def canvases_create(
self,
*,
title: Optional[str] = None,
document_content: Dict[str, str],
document_content: Optional[Dict[str, str]] = None,
channel_id: Optional[str] = None,
**kwargs,
) -> Union[Future, SlackResponse]:
"""Create Canvas for a user.

https://docs.slack.dev/reference/methods/canvases.create
"""
kwargs.update({"title": title, "document_content": document_content})
kwargs.update(
{
"title": title,
"document_content": document_content,
"channel_id": channel_id,
}
)
kwargs = _remove_none_values(kwargs)
return self.api_call("canvases.create", json=kwargs)

def canvases_edit(
Expand Down
4 changes: 2 additions & 2 deletions tests/slack_sdk_async/web/test_web_client_coverage.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -626,8 +626,8 @@ async def run_method(self, method_name, method, async_method):
self.api_methods_to_call.remove(method(id="R111")["method"])
await async_method(id="R111")
elif method_name == "canvases_create":
self.api_methods_to_call.remove(method(document_content={})["method"])
await async_method(document_content={})
self.api_methods_to_call.remove(method(channel_id="C123")["method"])
await async_method(channel_id="C123")
elif method_name == "conversations_canvases_create":
self.api_methods_to_call.remove(method(channel_id="C123", document_content={})["method"])
await async_method(channel_id="C123", document_content={})
Expand Down
Loading