Address created [beta]
This event occurs when a new address is created.
Type: object
Domain: entity
Event: address_creation
Version: 1
address_id required
Title: Address ID
Description: Unique numeric address ID.
Type: integer
entity_id
Title: Entity ID
Description: Unique numeric entity ID.
Type: integer
type required
Description: Address type.
Type: string
Max length: 12
Must be one of the following:
RESIDENTIAL
COMMERCIAL
OTHER
Example:
RESIDENTIAL
department
Title: Department
Description: Department ID of a large organization or building.
Type: string or null
Max length: 70
Example:
IT
sub_department
Title: Subdepartment
Description: Subdepartment ID of a large organization or building.
Type: string or null
Max length: 70
Example:
Web development
street_name
Title: Street name
Description: Street name.
Type: string or null
Max length: 70
Example:
Ocean Dr.
building_number
Title: Building number
Description: Building number.
Type: string or null
Max length: 16
Example:
201
building_name
Title: Building name
Description: Building or house name.
Type: string or null
Max length: 35
Example:
Sky Tower
floor
Title: Floor
Description: Floor within a building.
Type: string or null
Max length: 70
Example:
2nd
post_box
Title: Post box
Description: Numbered box in a postal office, assigned to a person or organization.
Type: string or null
Max length: 16
Example:
PO 101
room
Title: Room
Description: Building room number.
Type: string or null
Max length: 70
Example:
235
post_code
Title: Post code
Description: Alphanumeric postal code ID.
Type: string or null
Max length: 16
Example:
20900
town_name
Title: Town name
Description: Name of city or town.
Type: string or null
Max length: 35
Example:
San Diego
town_location_name
Title: Town location name
Description: Specific location name within the city or town.
Type: string or null
Max length: 35
Example:
Downtown
district_name
Title: District name
Description: District or another subdivision name.
Type: string or null
Max length: 35
Example:
Financial District
country_sub_division
Title: Country sub division
Description: Country subdivision such as state, region, province, or county.
Type: string or null
Max length: 35
Example:
California
country
Title: Country
Description: Two-letter country code.
Type: string or null
Max length: 2
Example:
US
address_line
Title: Address line
Description: Any additional free-form address information.
Type: string or null
Max length: 70
Example:
Suite B
is_active
Title: Active flag
Description: Indicates whether this address is active.
Type: boolean
metadata
Title: Address metadata
Description: Key/value field for custom information. (Limited to 1014 bytes.)
Type: object or null
Example:{ "value_1": 800, "value_2": "17f43184-f1b5-4bac-9fba-49e2d178d1a4" }
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://example.com/root.json",
"type": "object",
"title": "Address created [beta]",
"description": "This event occurs when a new address is created.",
"required": [
"address_id",
"type"
],
"properties": {
"address_id": {
"type": "integer",
"title": "Address ID",
"description": "Unique numeric address ID."
},
"entity_id": {
"type": "integer",
"title": "Entity ID",
"description": "Unique numeric entity ID."
},
"type": {
"type": "string",
"description": "Address type.",
"maxLength": 12,
"enum": [
"RESIDENTIAL",
"COMMERCIAL",
"OTHER"
],
"examples": [
"RESIDENTIAL"
]
},
"department": {
"type": [
"string",
"null"
],
"title": "Department",
"description": "Department ID of a large organization or building.",
"maxLength": 70,
"examples": [
"IT"
]
},
"sub_department": {
"type": [
"string",
"null"
],
"title": "Subdepartment",
"description": "Subdepartment ID of a large organization or building.",
"maxLength": 70,
"examples": [
"Web development"
]
},
"street_name": {
"type": [
"string",
"null"
],
"maxLength": 70,
"title": "Street name",
"description": "Street name.",
"examples": [
"Ocean Dr."
]
},
"building_number": {
"type": [
"string",
"null"
],
"maxLength": 16,
"title": "Building number",
"description": "Building number.",
"examples": [
"201"
]
},
"building_name": {
"type": [
"string",
"null"
],
"maxLength": 35,
"title": "Building name",
"description": "Building or house name.",
"examples": [
"Sky Tower"
]
},
"floor": {
"type": [
"string",
"null"
],
"maxLength": 70,
"title": "Floor",
"description": "Floor within a building.",
"examples": [
"2nd"
]
},
"post_box": {
"type": [
"string",
"null"
],
"maxLength": 16,
"title": "Post box",
"description": "Numbered box in a postal office, assigned to a person or organization.",
"examples": [
"PO 101"
]
},
"room": {
"type": [
"string",
"null"
],
"maxLength": 70,
"title": "Room",
"description": "Building room number.",
"examples": [
"235"
]
},
"post_code": {
"type": [
"string",
"null"
],
"maxLength": 16,
"title": "Post code",
"description": "Alphanumeric postal code ID.",
"examples": [
"20900"
]
},
"town_name": {
"type": [
"string",
"null"
],
"maxLength": 35,
"title": "Town name",
"description": "Name of city or town.",
"examples": [
"San Diego"
]
},
"town_location_name": {
"type": [
"string",
"null"
],
"maxLength": 35,
"title": "Town location name",
"description": "Specific location name within the city or town.",
"examples": [
"Downtown"
]
},
"district_name": {
"type": [
"string",
"null"
],
"maxLength": 35,
"title": "District name",
"description": "District or another subdivision name.",
"examples": [
"Financial District"
]
},
"country_sub_division": {
"type": [
"string",
"null"
],
"maxLength": 35,
"title": "Country sub division",
"description": "Country subdivision such as state, region, province, or county.",
"examples": [
"California"
]
},
"country": {
"type": [
"string",
"null"
],
"maxLength": 2,
"title": "Country",
"description": "Two-letter country code.",
"examples": [
"US"
]
},
"address_line": {
"type": [
"string",
"null"
],
"maxLength": 70,
"title": "Address line",
"description": "Any additional free-form address information.",
"examples": [
"Suite B"
]
},
"is_active": {
"type": "boolean",
"title": "Active flag",
"description": "Indicates whether this address is active."
},
"metadata": {
"type": [
"object",
"null"
],
"title": "Address metadata",
"description": "Key/value field for custom information. (Limited to 1014 bytes.)",
"examples": [
{
"value_1": 800,
"value_2": "17f43184-f1b5-4bac-9fba-49e2d178d1a4"
}
]
}
}
}
Updated 28 days ago