/users.profile.set - Slack Web API

Set the profile information for a user.

{ "ok": true, "profile": { "avatar_hash": "ge3b51ca72de", "display_name": "spengler", "display_name_normalized": "spengler", "email": "spengler@ghostbusters.example.com", "image_192": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_24": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_32": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_48": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_512": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_72": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "real_name": "Egon Spengler", "real_name_normalized": "Egon Spengler", "status_emoji": ":books:", "status_expiration": 0, "status_text": "Print is dead", "team": "T012AB3C4" } }

Request

Header Params

token

string

required

Authentication token. Requires scope: users.profile:write

Body Params application/x-www-form-urlencoded

name

string

optional

Name of a single key to set. Usable only if profile is not passed.

profile

string

optional

Collection of key:value pairs presented as a URL-encoded JSON hash. At most 50 fields may be set. Each field name is limited to 255 characters.

user

string

optional

ID of user to change. This argument may only be specified by team admins on paid teams.

value

string

optional

Value to set a single key to. Usable only if profile is not passed.

Responses

🟢200Typical success response

application/json

Body

Schema for successful response from users.profile.set method

email_pending

string <email>

optional

enum<boolean>

required

Allowed value:

true

profile

object (User profile object)

required

always_active

boolean

optional

api_app_id

string

optional

Match pattern:

^(A[A-Z0-9]{1,})?$

avatar_hash

string

required

bot_id

string

optional

Match pattern:

^B[A-Z0-9]{8,}$

display_name

string

required

display_name_normalized

string

required

string <email> | null

optional

fields

required

first_name

string | null

optional

guest_expiration_ts

integer | null

optional

guest_invited_by

string | null

optional

image_1024

string <uri> | null

optional

image_192

string <uri> | null

optional

image_24

string <uri> | null

optional

image_32

string <uri> | null

optional

image_48

string <uri> | null

optional

image_512

string <uri> | null

optional

image_72

string <uri> | null

optional

image_original

string <uri> | null

optional

is_app_user

boolean

optional

is_custom_image

boolean

optional

is_restricted

boolean | null

optional

is_ultra_restricted

boolean | null

optional

last_avatar_image_hash

string

optional

last_name

string | null

optional

memberships_count

integer

optional

name

string | null

optional

phone

string

required

pronouns

string

optional

real_name

string

required

real_name_normalized

string

required

skype

string

required

status_default_emoji

string

optional

status_default_text

string

optional

status_default_text_canonical

string | null

optional

status_emoji

string

required

status_expiration

integer

optional

status_text

string

required

status_text_canonical

string | null

optional

team

string

optional

Match pattern:

^[TE][A-Z0-9]{8,}$

title

string

required

updated

integer

optional

user_id

string

optional

username

string | null

optional

username

string

required

🔴500Typical error response