users.profile.set

• Your workspace must be on a paid plan to use the users.profile.set API method in order to change the profile for other users.
• You must select API as the Data source within the Configure Profiles admin tool in order to call this method.
• The users.profile.set API method requires you to use a user access token (starts with xoxp-).
• The role level for the token is determined by the user who installed the app.
• Org users cannot change their own profile details.
• You cannot change the profile details for another user unless you use a token that was generated by an Owner or Admin (For Enterprise Grid, this must be an Org Owner or Org Admin). You also cannot change the profile details for a user unless your role level is higher than theirs. Role levels from highest to lowest are: Primary Owner > Owner > Admin > Member > Guest. More information about roles can be found here. Therefore:
  • To change the profile of Admins, you must be using a token that was minimally generated by an Owner.
  • To change the profile of Owners, you must be using a token that was generated by a Primary Owner.

Profile fields

There are two ways to update non-custom profile fields with this method:

• Update one field at a time by passing the pair of arguments name and value.
• Update multiple fields by passing the argument profile.

You can update any of the following non-custom fields from the profile object within a Slack user object:

While profile image fields are present in the profile object, they cannot be set using the users.profile.set method. Use users.setPhoto and users.deletePhoto to update a user's profile image.

The following example payload updates the values of first_name, last_name, pronoun, and email for a user:

{
	"profile": {
		"first_name": "John",
		"last_name": "Smith",
		"pronouns": "they/them",
		"email": "john@smith.com"
	}
}

Custom profile fields

Custom fields are created within the organization admin tools. Once a field is created, you can update it for users with this API method.

Each custom profile field has a unique per-team ID. You can update a custom profile field by providing a key:value pair where the key is the relevant ID. Use team.profile.get to retrieve the profile fields and their IDs used by a team.

You can update a profile field by using the ID in the name field. To update custom profile fields, use the fields object instead. The fields object is an array of custom profile fields' key:value pairs.

If you update fields within the fields array, you can also choose to set the alt field. While the value of a field is what is usually displayed, the alt key will be displayed instead if it is set. The alt field can be up to 256 characters for all field types.

A field within the fields array needs a type. This determines the type of information value contains.

The following example sets the value of three fields; one with plain text, one with a date, and another with a link.

{
	"profile": {
		"fields": {
			"Xf0111111": {
				"value": "Barista",
				"alt": ""
			},
			"Xf0222222": {
				"value": "2022-04-11",
				"alt": ""
			},
			"Xf0333333": {
				"value": "https://example.com",
				"alt": ""
			}
		}
	}
}

Long_text (Flexible Text)

The value of a long_text field can be up to 5,000 characters of basic formatted mrkdown.

While you should use team.profile.get to get the ID for any field, including long-text fields, you should not copy the received schema. Below is a properly formatted payload for updating the long_text field with user.profile.set.

{
	"profile": {
		"fields": {
			"Xf0222222": {
				"value": "​​I make absolutely the best coffee you will *_ever_* taste. Learn more about where I studied <http://www.example.com|how to pull an espresso shot>. :coffee:",
				"alt": ""
			}
		}
	}
}

Tags (Smart Tags)

The value of a tags field contains distinct elements known as multi-value tags. Individual tags can hold up to 50 characters. Any number of tags can be created by admins, but end-users can only add 75 tags to each smart tag element on their profiles.

While you should use team.profile.get to get the ID for any field, including smart tag fields, you should not copy the received schema. Below is a properly formatted payload for updating the tags field with user.profile.set.

{
	"fields": {
		"Xf0333333": {
			"value": [
				"Mocha", "Latte", "Americano"
			], 
			"alt": ""
		}
	}
}

Name Pronunciation

The Name Pronunciation field lets a user provide a text description of how their name is pronounced. This text is displayed under their job title.

Use team.profile.get to obtain the field ID. Below is an example payload for updating the field once you have that ID:

{
	"profile": {
		"fields": {
			"Xf0444444": {
				"value": "Zoë is pronounced zo-ee",
				"alt": ""
			}
		}
	}
}

Status updates

This method is also used to set a user's current status.

Place the following status fields within the profile object when calling users.profile.set:

For example, the following payload sets a custom status of 🚆 riding a train and has it expire on July 26th, 2018 at 17:51:46 UTC:

{
	"profile": {
		"status_text": "riding a train",
		"status_emoji": ":train:",
		"status_expiration": 1532627506
	}
}

To manually unset a user's custom status, provide empty strings to both the status_text and status_emoji attributes: "".

Start dates

A user's start date can be found in the start_date non-custom profile field. You can update this field like any other non-custom profile field.

{
	"profile": {
		"start_date": "2022-10-22"
	},
	"user": "U123ABC456"
}

When you update a user's start date, both the start_date field and a custom profile field with its own unique field ID is updated.

While it's perfectly fine to just update start_date, you could also choose to update this custom field instead, after obtaining the custom field ID with team.profile.get. Updating one of these fields will update the other field accordingly.

{
    "profile": {
        "fields": {
            "Xf0123ABC456": {
                "value": "2022-10-22",
            }
    },
    "user": "U123ABC456",
}

Building your HTTP request

We strongly recommend using application/json POSTs when using this method. If you choose to use application/x-www-form-urlencoded, you must URL-encode the JSON provided to the profile field.

In general, you need to set your content type and authorization credentials to make an HTTP request. If you're using a workspace token, you need to provide an x-slack-user header indicating the user you're acting on behalf of.

You can send a JSON payload to users.profile.set with such an HTTP request:

POST /users/profile.set
Host: slack.com
Authorization: Bearer xoxp-secret-token
Content-type: application/json; charset=utf-8
{
    "profile": {
        "first_name": "John",
        "last_name": "Smith",
        "pronouns": "they/them",
        "email": "john@smith.com",
        "fields": {
            "Xf0111111": {
                "value": "Barista",
                "alt": ""
            },
            "Xf0222222": {
                "value": "2022-04-11",
                "alt": ""
            },
            "Xf0333333": {
                "value": "https://example.com",
                "alt": ""
            }
        }
    }
}

This method will generate a user_change event on success, containing the complete user.

Profile update rate limits

Update a user's profile, including custom status, sparingly. Special rate limit rules apply when updating profile data with users.profile.set. A token may update a single user's profile no more than 10 times per minute. And a single token may only set 30 user profiles per minute. Some burst behavior is allowed.