---
# @generated by sylphx-gen. Do not edit.
title: "Chat profiles"
description: "The `chat_profiles` collection of Sylphx Events: One platform Chat identity in a canonical shared Chat environment."
type: reference
product: queues
summary: "One platform Chat identity in a canonical shared Chat environment."
updated: 2026-09-28
order: 900
---

One platform Chat identity in a canonical shared Chat environment. Titles bind this same environment and client_id for shared friends, blocks, DMs and groups. A title_id is metadata, never a second identity or data authority. Unlinked guests use title-scoped client ids until a verified Auth account link merges their identity into the shared platform principal. Principal IDs are path-safe [A-Za-z0-9_.-], 1..128 bytes. Example guest.title.123 before linking, platform.authority.456 after verified linking.

**Service** Sylphx Events · **Resource type** `events.sylphx.com/ChatProfile` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/chat_profiles/{chat_profile}` · **Shape** `record`

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | Resource name; the last segment is the stable authenticated client id. |
| `uid` | `string` | Stable service-derived identifier. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `terms_version` | `string` | Accepted code of conduct version, before first send; includes disclosure that images go to a third-party AI model provider through Sylphx AI Gateway. Output only. |
| `display_name` | `string` | User-visible name. Output only. |
| `official` | `bool` | Trusted backend verification, never a message-supplied flag. Output only. |
| `allow_stranger_images` | `bool` | Explicit opt-in to images from non-mutual contacts; default false. Output only. |
| `online` | `bool` | Fresh presence on any joined conversation. Output only. |
| `activity` | `string` | Latest presence activity, including title and game, if the member supplied it. Output only. |
| `quiet_hours_start_utc_minute` | `int32` | UTC quiet-hours start in minutes, 0..1439. Omit both fields to disable. Output only. |
| `quiet_hours_end_utc_minute` | `int32` | UTC exclusive end, 0..1440; may wrap midnight. Output only. |
| `cosmetics` | `ChatCosmetics` | Appearance assigned only by a trusted tenant backend. Output only. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/chat_profiles#get) | Gets a Chat profile and fresh presence. |
| `POST` | [`configure`](/docs/api/chat_profiles#configure) | Configures an authenticated Chat identity through its trusted backend. |
| `POST` | [`set_relationship`](/docs/api/chat_profiles#set-relationship) | Changes friendship or a bilateral interaction block. |
| `GET` | [`list_relationships`](/docs/api/chat_profiles#list-relationships) | Lists friends and pending requests with presence. |
| `POST` | [`report`](/docs/api/chat_profiles#report) | Reports a message, image or user to the moderation queue. |
| `POST` | [`review_media`](/docs/api/chat_profiles#review-media) | Registers an image and its automated moderation receipt. |
| `POST` | [`set_official_status`](/docs/api/chat_profiles#set-official-status) | Verifies an official account through a distinct administrator permission. |
| `POST` | [`bind_identity`](/docs/api/chat_profiles#bind-identity) | Records an exact Auth-verified guest-to-platform identity link grant. |
| `POST` | [`merge_identity`](/docs/api/chat_profiles#merge-identity) | Rehomes linked guest state without discarding messages or relationships. |
| `POST` | [`register_push_device`](/docs/api/chat_profiles#register-push-device) | Registers a browser device using only the authenticated Chat session. |
| `POST` | [`unregister_push_device`](/docs/api/chat_profiles#unregister-push-device) | Removes this session's exact upstream device epoch; stale logout is a no-op. |
| `POST` | [`issue_token`](/docs/api/chat_profiles#issue-token) | Issues a bounded player capability after verified Auth token exchange. |

## get

Gets a Chat profile and fresh presence.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile` · scope `events:read` · effect `read` · [Request, response and examples](/docs/api/chat_profiles/get)

## configure

Configures an authenticated Chat identity through its trusted backend.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:configure` · scope `events:write` · effect `write` · [Request, response and examples](/docs/api/chat_profiles/configure)

## set_relationship

Changes friendship or a bilateral interaction block.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:setRelationship` · scope `events:write` · effect `write` · [Request, response and examples](/docs/api/chat_profiles/set_relationship)

## list_relationships

Lists friends and pending requests with presence.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:listRelationships` · scope `events:read` · effect `read` · [Request, response and examples](/docs/api/chat_profiles/list_relationships)

## report

Reports a message, image or user to the moderation queue.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:report` · scope `events:write` · effect `write` · [Request, response and examples](/docs/api/chat_profiles/report)

## review_media

Registers an image and its automated moderation receipt.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:reviewMedia` · scope `events:write` · effect `write` · [Request, response and examples](/docs/api/chat_profiles/review_media)

## set_official_status

Verifies an official account through a distinct administrator permission.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:setOfficialStatus` · scope `events:chat:admin` · effect `write` · [Request, response and examples](/docs/api/chat_profiles/set_official_status)

## bind_identity

Records an exact Auth-verified guest-to-platform identity link grant.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:bindIdentity` · scope `events:chat:admin` · effect `write` · [Request, response and examples](/docs/api/chat_profiles/bind_identity)

## merge_identity

Rehomes linked guest state without discarding messages or relationships.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:mergeIdentity` · scope `events:chat:admin` · effect `write` · [Request, response and examples](/docs/api/chat_profiles/merge_identity)

## register_push_device

Registers a browser device using only the authenticated Chat session.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:registerPushDevice` · scope `events:write` · effect `write` · [Request, response and examples](/docs/api/chat_profiles/register_push_device)

## unregister_push_device

Removes this session's exact upstream device epoch; stale logout is a no-op.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:unregisterPushDevice` · scope `events:write` · effect `write` · [Request, response and examples](/docs/api/chat_profiles/unregister_push_device)

## issue_token

Issues a bounded player capability after verified Auth token exchange.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:issueToken` · scope `events:write` · effect `write` · [Request, response and examples](/docs/api/chat_profiles/issue_token)