Recipient Definition¶

JSON Schema: Recipient_Definition.schema.json

Title: Recipient Definition


Type	`object`
Required	No
Additional properties	Not allowed

Description: Voluptuous validation schema for Recipient_Definition

Property	Pattern	Type	Deprecated
- person	No	string	No
- user_id	No	string	No
- alias	No	string	No
- email	No	string	No
- enabled	No	boolean	No
- target	No	Combination	No
- phone_number	No	string	No
- mobile_discovery	No	boolean	No
- mobile_devices	No	array of object	No
- delivery	No	object	No

Property `Recipient Definition > person`¶


Type	`string`
Required	No

Property `Recipient Definition > user_id`¶


Type	`string`
Required	No

Property `Recipient Definition > alias`¶


Type	`string`
Required	No

Property `Recipient Definition > email`¶


Type	`string`
Required	No

Property `Recipient Definition > enabled`¶


Type	`boolean`
Required	No
Default	`true`

Property `Recipient Definition > target`¶


Type	`combining`
Required	No
Additional properties	Any type allowed

Any of(Option)
item 0
item 1
item 2

Property `Recipient Definition > target > anyOf > item 0`¶


Type	`object`
Required	No
Additional properties	Each additional property must conform to the schema

Property	Pattern	Type	Deprecated
- entity_id	No	array of string	No
- device_id	No	array of string	No
- area_id	No	array of string	No
- floor_id	No	array of string	No
- label_id	No	array of string	No
- email	No	array of string	No
- phone	No	array of string	No
- mobile_app_id	No	array of string	No
- person_id	No	array of string	No
- Additional properties	No	array of string	No

Property `Recipient Definition > target > anyOf > item 0 > entity_id`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
entity_id items	-

Recipient Definition > target > anyOf > item 0 > entity_id > entity_id items¶


Type	`string`
Required	No

Property `Recipient Definition > target > anyOf > item 0 > device_id`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
device_id items	-

Recipient Definition > target > anyOf > item 0 > device_id > device_id items¶


Type	`string`
Required	No

Property `Recipient Definition > target > anyOf > item 0 > area_id`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
area_id items	-

Recipient Definition > target > anyOf > item 0 > area_id > area_id items¶


Type	`string`
Required	No

Property `Recipient Definition > target > anyOf > item 0 > floor_id`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
floor_id items	-

Recipient Definition > target > anyOf > item 0 > floor_id > floor_id items¶


Type	`string`
Required	No

Property `Recipient Definition > target > anyOf > item 0 > label_id`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
label_id items	-

Recipient Definition > target > anyOf > item 0 > label_id > label_id items¶


Type	`string`
Required	No

Property `Recipient Definition > target > anyOf > item 0 > email`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
email items	-

Recipient Definition > target > anyOf > item 0 > email > email items¶


Type	`string`
Required	No

Property `Recipient Definition > target > anyOf > item 0 > phone`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
phone items	-

Recipient Definition > target > anyOf > item 0 > phone > phone items¶


Type	`string`
Required	No

Property `Recipient Definition > target > anyOf > item 0 > mobile_app_id`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
mobile_app_id items	-

Recipient Definition > target > anyOf > item 0 > mobile_app_id > mobile_app_id items¶


Type	`string`
Required	No

Property `Recipient Definition > target > anyOf > item 0 > person_id`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
person_id items	-

Recipient Definition > target > anyOf > item 0 > person_id > person_id items¶


Type	`string`
Required	No

Property `Recipient Definition > target > anyOf > item 0 > additionalProperties`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
additionalProperties items	-

Recipient Definition > target > anyOf > item 0 > additionalProperties > additionalProperties items¶


Type	`string`
Required	No

Property `Recipient Definition > target > anyOf > item 1`¶


Type	`string`
Required	No

Property `Recipient Definition > target > anyOf > item 2`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
item 2 items	-

Recipient Definition > target > anyOf > item 2 > item 2 items¶


Type	`string`
Required	No

Property `Recipient Definition > phone_number`¶


Type	`string`
Required	No

Property `Recipient Definition > mobile_discovery`¶


Type	`boolean`
Required	No
Default	`true`

Property `Recipient Definition > mobile_devices`¶


Type	`array of object`
Required	No
Default	`[]`

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
mobile_devices items	-

Recipient Definition > mobile_devices > mobile_devices items¶


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated
- manufacturer	No	string	No
- model	No	string	No
- class	No	string	No
- mobile_app_id	No	string	No
- device_tracker	No	string	No
- enabled	No	boolean	No

Property `Recipient Definition > mobile_devices > mobile_devices items > manufacturer`¶


Type	`string`
Required	No

Property `Recipient Definition > mobile_devices > mobile_devices items > model`¶


Type	`string`
Required	No

Property `Recipient Definition > mobile_devices > mobile_devices items > class`¶


Type	`string`
Required	No

Property `Recipient Definition > mobile_devices > mobile_devices items > mobile_app_id`¶


Type	`string`
Required	No

Property `Recipient Definition > mobile_devices > mobile_devices items > device_tracker`¶


Type	`string`
Required	No

Property `Recipient Definition > mobile_devices > mobile_devices items > enabled`¶


Type	`boolean`
Required	No
Default	`true`

Property `Recipient Definition > delivery`¶


Type	`object`
Required	No
Additional properties	Each additional property must conform to the schema
Default	`{}`

Property	Pattern	Type	Deprecated
- Additional properties	No	object	No

Property `Recipient Definition > delivery > additionalProperties`¶


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated
- target	No	Combination	No
- enabled	No	boolean	No
- data	No	object	No

Property `Recipient Definition > delivery > additionalProperties > target`¶


Type	`combining`
Required	No
Additional properties	Any type allowed

Any of(Option)
item 0
item 1
item 2

Property `Recipient Definition > delivery > additionalProperties > target > anyOf > item 0`¶


Type	`object`
Required	No
Additional properties	Each additional property must conform to the schema

Property	Pattern	Type	Deprecated
- entity_id	No	array of string	No
- device_id	No	array of string	No
- area_id	No	array of string	No
- floor_id	No	array of string	No
- label_id	No	array of string	No
- email	No	array of string	No
- phone	No	array of string	No
- mobile_app_id	No	array of string	No
- person_id	No	array of string	No
- Additional properties	No	array of string	No

Property `Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > entity_id`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
entity_id items	-

Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > entity_id > entity_id items¶


Type	`string`
Required	No

Property `Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > device_id`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
device_id items	-

Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > device_id > device_id items¶


Type	`string`
Required	No

Property `Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > area_id`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
area_id items	-

Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > area_id > area_id items¶


Type	`string`
Required	No

Property `Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > floor_id`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
floor_id items	-

Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > floor_id > floor_id items¶


Type	`string`
Required	No

Property `Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > label_id`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
label_id items	-

Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > label_id > label_id items¶


Type	`string`
Required	No

Property `Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > email`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
email items	-

Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > email > email items¶


Type	`string`
Required	No

Property `Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > phone`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
phone items	-

Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > phone > phone items¶


Type	`string`
Required	No

Property `Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > mobile_app_id`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
mobile_app_id items	-

Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > mobile_app_id > mobile_app_id items¶


Type	`string`
Required	No

Property `Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > person_id`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
person_id items	-

Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > person_id > person_id items¶


Type	`string`
Required	No

Property `Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > additionalProperties`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
additionalProperties items	-

Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > additionalProperties > additionalProperties items¶


Type	`string`
Required	No

Property `Recipient Definition > delivery > additionalProperties > target > anyOf > item 1`¶


Type	`string`
Required	No

Property `Recipient Definition > delivery > additionalProperties > target > anyOf > item 2`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
item 2 items	-

Recipient Definition > delivery > additionalProperties > target > anyOf > item 2 > item 2 items¶


Type	`string`
Required	No

Property `Recipient Definition > delivery > additionalProperties > enabled`¶


Type	`boolean`
Required	No

Property `Recipient Definition > delivery > additionalProperties > data`¶


Type	`object`
Required	No
Additional properties	Each additional property must conform to the schema

Property	Pattern	Type	Deprecated
- Additional properties	No	Combination	No

Property `Recipient Definition > delivery > additionalProperties > data > additionalProperties`¶


Type	`combining`
Required	No
Additional properties	Any type allowed

Any of(Option)
item 0
item 1
item 2
item 3
item 4
item 5
item 6

Property `Recipient Definition > delivery > additionalProperties > data > additionalProperties > anyOf > item 0`¶


Type	`string`
Required	No

Property `Recipient Definition > delivery > additionalProperties > data > additionalProperties > anyOf > item 1`¶


Type	`integer`
Required	No

Property `Recipient Definition > delivery > additionalProperties > data > additionalProperties > anyOf > item 2`¶


Type	`boolean`
Required	No

Property `Recipient Definition > delivery > additionalProperties > data > additionalProperties > anyOf > item 3`¶


Type	`number`
Required	No

Property `Recipient Definition > delivery > additionalProperties > data > additionalProperties > anyOf > item 4`¶


Type	`object`
Required	No
Additional properties	Any type allowed

Property	Pattern	Type	Deprecated
- Additional properties	No	object	No

Property `Recipient Definition > delivery > additionalProperties > data > additionalProperties > anyOf > item 5`¶


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
item 5 items	-

Recipient Definition > delivery > additionalProperties > data > additionalProperties > anyOf > item 5 > item 5 items¶


Type	`string`
Required	No

Property `Recipient Definition > delivery > additionalProperties > data > additionalProperties > anyOf > item 6`¶


Type	`object`
Required	No
Additional properties	Any type allowed

Description: Must be null

Generated using json-schema-for-humans on 2026-09-25 at 21:14:33 +0000

Recipient Definition¶

Property Recipient Definition > person¶

Property Recipient Definition > user_id¶

Property Recipient Definition > alias¶

Property Recipient Definition > email¶

Property Recipient Definition > enabled¶

Property Recipient Definition > target¶

Property Recipient Definition > target > anyOf > item 0¶

Property Recipient Definition > target > anyOf > item 0 > entity_id¶

Recipient Definition > target > anyOf > item 0 > entity_id > entity_id items¶

Property Recipient Definition > target > anyOf > item 0 > device_id¶

Recipient Definition > target > anyOf > item 0 > device_id > device_id items¶

Property Recipient Definition > target > anyOf > item 0 > area_id¶

Recipient Definition > target > anyOf > item 0 > area_id > area_id items¶

Property Recipient Definition > target > anyOf > item 0 > floor_id¶

Recipient Definition > target > anyOf > item 0 > floor_id > floor_id items¶

Property Recipient Definition > target > anyOf > item 0 > label_id¶

Recipient Definition > target > anyOf > item 0 > label_id > label_id items¶

Property Recipient Definition > target > anyOf > item 0 > email¶

Recipient Definition > target > anyOf > item 0 > email > email items¶

Property Recipient Definition > target > anyOf > item 0 > phone¶

Recipient Definition > target > anyOf > item 0 > phone > phone items¶

Property Recipient Definition > target > anyOf > item 0 > mobile_app_id¶

Recipient Definition > target > anyOf > item 0 > mobile_app_id > mobile_app_id items¶

Property Recipient Definition > target > anyOf > item 0 > person_id¶

Recipient Definition > target > anyOf > item 0 > person_id > person_id items¶

Property Recipient Definition > target > anyOf > item 0 > additionalProperties¶

Recipient Definition > target > anyOf > item 0 > additionalProperties > additionalProperties items¶

Property Recipient Definition > target > anyOf > item 1¶

Property Recipient Definition > target > anyOf > item 2¶

Recipient Definition > target > anyOf > item 2 > item 2 items¶

Property Recipient Definition > phone_number¶

Property Recipient Definition > mobile_discovery¶

Property Recipient Definition > mobile_devices¶

Recipient Definition > mobile_devices > mobile_devices items¶

Property Recipient Definition > mobile_devices > mobile_devices items > manufacturer¶

Property Recipient Definition > mobile_devices > mobile_devices items > model¶

Property Recipient Definition > mobile_devices > mobile_devices items > class¶

Property Recipient Definition > mobile_devices > mobile_devices items > mobile_app_id¶

Property Recipient Definition > mobile_devices > mobile_devices items > device_tracker¶

Property Recipient Definition > mobile_devices > mobile_devices items > enabled¶

Property Recipient Definition > delivery¶

Property Recipient Definition > delivery > additionalProperties¶

Property Recipient Definition > delivery > additionalProperties > target¶

Property Recipient Definition > delivery > additionalProperties > target > anyOf > item 0¶

Property Recipient Definition > delivery > additionalProperties > target > anyOf > item 0 > entity_id¶