---
title: "Add Work Custom Emoji"
method: POST
path: "/work/custom-emoji"
tags: ["Work"]
---

# Add Work Custom Emoji

`POST /work/custom-emoji`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/work/custom-emoji`
- Auth: HTTP bearer

Register one custom emoji for the whole organization.

``url`` must be ``https:`` and is refused rather than coerced: a custom
emoji renders in every member's browser. ``shortcode`` is lower-cased and
must be 2-32 characters of ``a-z 0-9 _ + -``. The response carries the
organization's whole emoji set.

## Headers

- `Idempotency-Key` string, nullable: Retry-safety key. Replaying one returns the ORIGINAL result with `duplicate: true` instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again — send your own for anything you may retry.
- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- WorkCustomEmojiRequest: One organization-wide custom emoji. The URL is constrained to `https:` on purpose and refused rather than coerced. A custom emoji is rendered by every member's browser in every channel that uses it, so an `http:` or `javascript:` URL here is not a formatting problem — it is a stored payload with an audience.
  - `shortcode` string, required
  - `url` string, required

## Response `201`

Successful Response

- ApiResponseWorkCustomEmojiResult
  - `data` WorkCustomEmojiResult, required: The organization's custom emoji after one registration.
    - `event` object, nullable: The room event the write appended
    - `customEmojis` object[], nullable: Every custom emoji the organization now has
    - `duplicate` boolean, nullable: True when an Idempotency-Key replay returned the original result
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)