---
url: /api/formats/scope/src/interfaces/ScopeMessage.md
---
[pantoken-root](../../../../index.md) / [formats/scope/src](../index.md) / ScopeMessage

# Interface: ScopeMessage

Beta

The message envelope exchanged between a scope and its attached frames.

## Extends

* [`ScopeConfig`](ScopeConfig.md)

## Properties

### theme?

> `optional` **theme?**: `string`

Beta

Theme key, e.g. `"rebrand"`. Matched by `[data-pantoken-theme="…"]`.

#### Inherited from

[`ScopeConfig`](ScopeConfig.md).[`theme`](ScopeConfig.md#theme)

***

### scheme?

> `optional` **scheme?**: [`Scheme`](../type-aliases/Scheme.md)

Beta

Pinned color scheme. Omit to follow the OS preference.

#### Inherited from

[`ScopeConfig`](ScopeConfig.md).[`scheme`](ScopeConfig.md#scheme)

***

### color?

> `optional` **color?**: `string`

Beta

Custom brand color key.

#### Inherited from

[`ScopeConfig`](ScopeConfig.md).[`color`](ScopeConfig.md#color)

***

### type

> **type**: `"pantoken-scope"` | `"pantoken-scope-request"`

Beta

***

### instanceId

> **instanceId**: `string`

Beta

Identifier of the pantoken instance that owns this scope.

#### Overrides

[`ScopeConfig`](ScopeConfig.md).[`instanceId`](ScopeConfig.md#instanceid)