You must enable javascript in order to use the Slack API Documentation. You can do this in your browser settings.
Go to Slack


You're not signed into any teams. Sign in to test authentication.

This method allows the user to set their profile image. The caller can pass image data via image.

Providing a "crop box" with crop_x, crop_y, and crop_w is optional. Otherwise, the whole image will be used. If cropping instructions are not specified and the source image is not square, the image will be letterboxed, just like your favorite old laserdiscs.

Please limit your images to a maximum size of 1024 by 1024 pixels. 512x512 pixels is the minimum.

To remove a profile image, use the companion method users.deletePhoto.


Argument Example Required Description
token xxxx-xxxxxxxxx-xxxx Required

Authentication token bearing required scopes.

image ... Required

File contents via multipart/form-data.

crop_w 100 Optional

Width/height of crop box (always square)

crop_x 10 Optional

X coordinate of top-left corner of crop box

crop_y 15 Optional

Y coordinate of top-left corner of crop box

Present arguments as parameters in application/x-www-form-urlencoded querystring or POST body. This method does not currently accept application/json.

Use this method with a HTTP POST and provide your HTTP Content-type as multipart/form-data.

When providing the image parameter, provide your image data directly but present its correct Content-type, such as image/gif, image/jpeg, image/png, etc.


    "ok": true


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 params in the response.

Error Description

The uploaded image could not be processed - try passing a JPEG, GIF or PNG


The uploaded image had excessive dimensions


An animated GIF with too many frames was uploaded


No authentication token provided.


Some 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.


Authentication token is for a deleted user or workspace.


Authentication token is for a deleted user or workspace or the app has been removed.


The workspace token used in this request does not have the permissions necessary to complete the request.


This method cannot be called by a bot user.


The 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.


The method was passed a PHP-style array argument (e.g. with a name like foo[7]). These are never valid with the Slack API.


The 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.


The 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.


The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/x-www-form-urlencoded multipart/form-data text/plain.


The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.


The 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.


The method was called via a POST request, but the POST data was either missing or truncated.


The 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.


This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.

Warning Description

The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.


The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous.

Argument Value
token Required Generate tokens to test with here.
image Required
crop_w Optional
crop_x Optional
crop_y Optional
Extra args