--- title: "admin.emoji.add API method" summary: "Add an emoji." url: "https://docs.slack.dev/reference/methods/admin.emoji.add" type: "reference" subtype: "method" method_name: "admin.emoji.add" http_method: "GET" rate_limit: "t2" scopes: user: ["admin.teams:write"] --- Source: https://docs.slack.dev/reference/methods/admin.emoji.add # admin.emoji.add method DocsCall generator The features within are only available to Slack workspaces on an Enterprise plan. Don't have a paid plan? Join the [Developer Program](https://api.slack.com/developer-program) and provision a fully-featured sandbox for free. ## Facts {#facts} **Description**Add an emoji. **Method Access** * HTTP * Slack CLI * JavaScript * Python * Java ``` GET https://slack.com/api/admin.emoji.add ``` [![slack-cli](/img/logos/slack-cli.png)](/tools/slack-cli) ``` slack api admin.emoji.add ``` [![bolt-js](/img/logos/bolt-js-logo.svg)](/tools/bolt-js) ``` app.client.admin.emoji.add ``` [![bolt-py](/img/logos/bolt-py-logo.svg)](/tools/bolt-python) ``` app.client.admin_emoji_add ``` [![bolt-java](/img/logos/bolt-java-logo.svg)](/tools/java-slack-sdk/guides/getting-started-with-bolt) ``` app.client().adminEmojiAdd ``` **Scopes** User token: [`admin.teams:write`](https://docs.slack.dev/reference/scopes/admin.teams.write.md) **Content types** `application/x-www-form-urlencoded` **Rate Limits**[Tier 2: 20+ per minute](https://docs.slack.dev/apis/web-api/rate-limits.md) ## Arguments {#arguments} ### Required arguments **`token`**`string`Required Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter. _Example:_ `xxxx-xxxxxxxxx-xxxx` **`name`**`string`Required The name of the emoji to be added (using lower-case letters only). Colons (`:myemoji:`) around the value are not required, although they may be included. ### Optional arguments **`url`**`string`Optional The URL of a file to use as an image for the emoji. Square images under 128KB and with transparent backgrounds work best. ## Usage info {#usage-info} This [Admin API method](https://docs.slack.dev/admins.md) adds a custom emoji across an Enterprise organization. This admin scope is obtained through version two of the OAuth V2 flow, but there are a few additional requirements. The app requesting this scope must be installed by an admin or Owner of an Enterprise organization. Also, the app must be installed on the entire org, not on an individual workspace. See below for more details. If the app is installed by an Org Admin or Owner, ensure the Channel Management settings provide the appropriate permissions. The Org Admin or Owner installing the app must have the **Channel Management** role, and must also be granted access to **Public channels** and **Private channels** within this role. If these criteria aren't met, the Org Admin or Owner will receive a `not_allowed` error when attempting to install an app. Admin API endpoints reach across **an entire Enterprise organization**, not individual workspaces. For a token to be imbued with Admin scopes, it must be obtained from installing an app on the **entire Enterprise org**, not just a workspace within the organization. To configure and install an app supporting Admin API endpoints on your Enterprise organization: 1. [Create a new Slack app](https://api.slack.com/apps). Your app will need to be able to handle a standard [OAuth 2 flow](https://docs.slack.dev/authentication/installing-with-oauth.md). 2. In the app's settings, select **OAuth & Permissions** from the left navigation. Scroll down to the section titled **Scopes** and add the `admin.*` scope you want. Click the **Save Changes** button. 3. In the app's settings, select **Manage Distribution** from the left navigation. Under the section titled **Share Your App with Other Workspaces**, make sure all four sections have the green check. Then click the green **Activate Public Distribution** button. 4. Under the **Share Your App with Your Workspace** section, copy the **Sharable URL** and paste it into a browser to initiate the OAuth handshake that will install the app on your organization. You must be logged in as an **admin or Owner** of your Enterprise organization to install the app. 5. Check the dropdown in the upper right of the installation screen to make sure you are installing the app on the organization, not an individual workspace within the organization. See the image below for a visual. 6. Once your app completes the OAuth flow, you will be granted an OAuth token that can be used for calling Admin API methods for your organization. ![](/img/guides/admin/workspace-v-org-audit.png) _When installing an app to use an Admin API endpoint, be sure to install it on your Enterprise organization, not a workspace within the organization._ * * * ## Response {#response} #### Typical success response ``` { "ok": true} ``` ## Errors {#errors} 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` parameter in the response. Error Description `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. `deprecated_endpoint` The endpoint has been deprecated. `ekm_access_denied` Administrators have suspended the ability to post a message. `emoji_limit_reached` Unable to add emoji due to limit reached. `enterprise_is_restricted` The method cannot be called from an Enterprise. `error_bad_format` Invalid image data was provided. `error_bad_name_i18n` Value passed for `name` was invalid. `error_bad_upload` There was an error uploading the image. `error_bad_wide` The image width or height is too large. `error_lower_case_names_only` Capital letters are not allowed in emoji names. `error_missing_name` Value passed for `name` is missing or empty. `error_name_taken` Value passed for `name` already exists. `error_name_taken_i18n` Value passed for `name` already exists. `error_no_image` Empty image data was provided. `error_too_big` The image file size is too large. `failed_to_add_emoji` Failed to add the specified emoji. `failed_to_fetch_active_team` There are no active teams on the org and we need at least one. `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. `feature_not_enabled` The Admin APIs feature is not enabled for this team. `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_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_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`. `method_deprecated` The method has been deprecated. `missing_argument` A required argument was not provided. The response's `arg` field names the missing argument. Arguments sent in a JSON body are ignored by methods that don't list `application/json` as a content type. `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. `no_image_uploaded` No image data was provided. `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_allowed_token_type` The token type used in this request is not allowed. `not_an_admin` This method is only accessible by org owners and Admins. `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. `ratelimited` Too many api calls in a time period. `request_timeout` The method was called via a `POST` request, but the `POST` data was either missing or truncated. `resized_but_still_too_large` The image is still too large after resizing. `service_unavailable` The service is temporarily unavailable `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_many_frames` The image has too many frames. `two_factor_setup_required` Two factor setup is required.