Facts
application/x-www-form-urlencoded application/json Arguments
Required arguments
tokenstringRequiredAuthentication token bearing the code_channels:manage scope. Must be a granular bot token.
xxxx-xxxxxxxxx-xxxxchannelstringRequiredID of the agent session channel the canvas is attached to.
canvas_idRequiredEncoded ID of the canvas whose content to replace.
contentstringRequiredThe full new canvas content as markdown. The server diffs this against the current content and applies only the changed sections.
Usage info
Your agent sends the whole canvas document as markdown. Rather than overwrite the entire canvas, Slack diffs your content against the canvas's current sections and applies only the minimal set of section-level edits. Sections you didn't change keep their section IDs, and therefore any comment threads anchored to them persist after the update. This is how a comment-only plan canvas works, as a full-document replace would re-ID every section and orphan every comment on each revision. With this method, your agent can make revisions to the plan canvas while the human's feedback stays anchored to the text it was written against.
The intended loop for a comment-only canvas is as follows:
- Attach the canvas as a view with the
agents.conversations.setViewAPI method usingtype: "canvas"andaccess_level: "comment", so channel members can read and comment but only your agent edits the text. - Read unresolved comments with the
agents.conversations.getCanvasAPI method and fold them into your agent's context. - Write the revised document back with this API method.
If the content you send is byte-for-byte current, the call is a no-op and returns sections_changed_count: 0 without bumping the canvas version.
Example request
POST /api/agents.conversations.setCanvasContent
{
"channel": "C9876543210",
"canvas_id": "F1234567890",
"content": "# Migration plan\n\n1. Inventory cron jobs\n2. Port billing jobs last\n"
}
Response
Typical success response
{
"ok": true,
"canvas_id": "F1234567890",
"sections_changed_count": 2
}
Typical error response
{
"ok": false,
"error": "canvas_not_found"
}
Errors
This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok parameter in the response.
access_deniedAccess to a resource specified in the request is denied.
accesslimitedAccess to this method is limited on the current network
account_inactiveAuthentication token is for a deleted user or workspace when using a bot token.
canvas_content_fetch_failedThe canvas's current content could not be read to compute the diff.
canvas_content_update_failedThe canvas content could not be updated.
canvas_not_foundThe specified canvas_id does not correspond to a canvas you can access.
channel_not_foundThe specified channel does not correspond to a valid channel.
content_too_largeThe provided content exceeds the maximum canvas size.
deprecated_endpointThe endpoint has been deprecated.
ekm_access_deniedAdministrators have suspended the ability to post a message.
enterprise_is_restrictedThe method cannot be called from an Enterprise.
fatal_errorThe server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
internal_errorThe server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.
invalid_arg_nameThe method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.
invalid_argumentsThe method was called with invalid arguments.
invalid_array_argThe method was passed an array as an argument. Please only input valid strings.
invalid_authSome aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
invalid_charsetThe method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.
invalid_form_dataThe method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.
invalid_post_typeThe method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.
method_deprecatedThe method has been deprecated.
missing_argumentA required argument was not provided. The response's arg field names the missing argument. Arguments sent in a JSON body are ignored by methods that don't list application/json as a content type.
missing_post_typeThe method was called via a POST request and included a data payload, but the request did not include a Content-Type header.
missing_scopeThe token used is not granted the specific scope permissions required to complete this request.
no_permissionThe workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.
not_agent_channelThe specified channel is not an agent session channel.
not_allowed_token_typeThe token type used in this request is not allowed.
not_authedNo authentication token provided.
not_authorizedThe caller is not an authorized agent bot for this channel.
org_login_requiredThe workspace is undergoing an enterprise migration and will not be available until migration is complete.
ratelimitedThe request has been ratelimited. Refer to the Retry-After header for when to retry the request.
request_timeoutThe method was called via a POST request, but the POST data was either missing or truncated.
service_unavailableThe service is temporarily unavailable
team_access_not_grantedThe token used is not granted the specific workspace access required to complete this request.
team_added_to_orgThe workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.
token_expiredAuthentication token has expired
token_revokedAuthentication token is for a deleted user or workspace or the app has been removed when using a user token.
too_many_sectionsThe provided content or the existing canvas has too many sections to diff. Reduce the number of distinct blocks (paragraphs, headings, code fences) in the document.
two_factor_setup_requiredTwo factor setup is required.
