Current section
Files
Jump to
Current section
Files
lib/slack/web/docs/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": {
"access_denied": "Access to a resource specified in the request is denied.",
"accesslimited": "Access to this method is limited on the current network",
"account_inactive": "Authentication token is for a deleted user or workspace when using a `bot` token.",
"cannot_update_admin_user": "Only a primary owner can update the profile of an admin.",
"deprecated_endpoint": "The endpoint has been deprecated.",
"ekm_access_denied": "Administrators have suspended the ability to post a message.",
"email_taken": "email taken",
"enterprise_is_restricted": "The method cannot be called from an Enterprise.",
"fatal_error": "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.",
"internal_error": "The 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_name": "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.",
"invalid_arguments": "The method was called with invalid arguments.",
"invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.",
"invalid_auth": "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.",
"invalid_charset": "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`.",
"invalid_emoji_not_allowed": "Invalid emoji not allowed.",
"invalid_form_data": "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.",
"invalid_ooo_message": "Invalid Out of Office message.",
"invalid_post_type": "The 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`.",
"invalid_profile": "Profile object passed in is not valid JSON (make sure it is URL encoded!).",
"invalid_starts_with_at": "Name cannot start with @.",
"method_deprecated": "The method has been deprecated.",
"missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.",
"missing_scope": "The token used is not granted the specific scope permissions required to complete this request.",
"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.",
"no_permission": "The 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_admin": "Only admins can update the profile of another user. Some fields, like `email` may only be updated by an admin.",
"not_allowed_token_type": "The token type used in this request is not allowed.",
"not_app_admin": "Only team owners and selected members can update the profile of a bot user.",
"not_authed": "No authentication token provided.",
"org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.",
"partial_profile_set_failed": "Failed to set user profile.",
"permission_denied": "Permission denied.",
"profile_set_failed": "Failed to set user profile.",
"ratelimited": "The request has been ratelimited. Refer to the `Retry-After` header for when to retry the request.",
"request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.",
"reserved_name": "First or last name are reserved.",
"service_unavailable": "The service is temporarily unavailable",
"sudo_required": "Request requires sudo session.",
"team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.",
"team_added_to_org": "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.",
"token_expired": "Authentication token has expired",
"token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a `user` token.",
"too_long": "You attempted to set a custom status but it was longer than the maximum allowed, 100.",
"two_factor_setup_required": "Two factor setup is required.",
"username_same": "Username is the same as the current username."
}
}