Current section
Files
Jump to
Current section
Files
priv/docs/methods/users.profile.set.json
{
"args": {
"name": {
"desc": "Name of a single key to set. Usable only if `profile` is not passed. Update one field at a time by passing the pair of arguments `name` and `value`.",
"example": "first_name",
"required": false,
"type": "string"
},
"profile": {
"desc": "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. You can update any of the following non-custom fields from the `profile` object within a Slack `user` object:",
"example": "{ first_name: \"John\", ... }",
"required": false,
"type": "string"
},
"user": {
"desc": "ID of user to change. This argument may only be specified by admins on paid teams. You can update any of the following non-custom fields from the `profile` object within a Slack `user` object:",
"required": false,
"type": "string"
},
"value": {
"desc": "Value to set a single key to. Usable only if `profile` is not passed. Update one field at a time by passing the pair of arguments `name` and `value`.",
"example": "John",
"required": false,
"type": "string"
}
},
"desc": "Set a user's profile information, including custom status.",
"errors": {
"cannot_update_admin_user": "Only a primary owner can update the profile of an admin.",
"email_taken": "email taken",
"invalid_emoji_not_allowed": "Invalid emoji not allowed.",
"invalid_ooo_message": "Invalid Out of Office message.",
"invalid_profile": "Profile object passed in is not valid JSON (make sure it is URL encoded!).",
"invalid_starts_with_at": "Name cannot start with @.",
"must_clear_both_status_text_and_status_emoji": "Clearing the status requires setting both `status_text` and `status_emoji` to ''.",
"name_not_allowed": "name cannot contain URL.",
"not_admin": "Only admins can update the profile of another user. Some fields, like `email` may only be updated by an admin.",
"not_app_admin": "Only team owners and selected members can update the profile of a bot user.",
"partial_profile_set_failed": "Failed to set user profile.",
"permission_denied": "Permission denied.",
"profile_set_failed": "Failed to set user profile.",
"reserved_name": "First or last name are reserved.",
"sudo_required": "Request requires sudo session.",
"too_long": "You attempted to set a custom status but it was longer than the maximum allowed, 100.",
"username_same": "Username is the same as the current username."
},
"rate_limit": {
"label": "Tier 3: 50+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"user": [
{
"name": "users.profile:write",
"url": "https://docs.slack.dev/reference/scopes/users.profile.write"
}
]
}
}