Skip to main content

AddressProfileInput

visibilitystring

Defaults to public on create; omitted/null PATCH preserves it. Changes invalidate all guest links.

Possible values: [public, private]

slugstringrequired

3-30 chars, lowercase letters/numbers/hyphens. Ignored on PATCH (the URL slug is authoritative).

Example: kofi
phonestring
Example: +233241234567
display_namestring
Example: Kofi Mensah
hex_codestring

Optional AfriHex hex code for this location

Example: AK-484-9321
latnumber<double>required
Example: 5.6037
lngnumber<double>required
Example: -0.187
labelstring

Human-readable description of the spot

Example: Blue gate opposite Goil, third house
notesstring
compoundstringnullable

Owner-supplied compound/building name, visible to authorized recipients. Trimmed; empty string clears it.

Possible values: <= 120 characters

Example: Mensah compound
unitstringnullable

Room, flat, or shop identifier, following profile visibility. Trimmed; empty string clears it.

Possible values: <= 80 characters

Example: Shop 4
floorstringnullable

Floor description following profile visibility; free text to avoid ambiguous floor numbering. Trimmed.

Possible values: <= 40 characters

Example: Ground floor
alert_emailstring

Required if flood_alerts_on is true

Example: kofi@example.com
flood_alerts_onboolean

Opt in to proactive flood alerts for this saved location

AddressProfileInput
{
"visibility": "public",
"slug": "kofi",
"phone": "+233241234567",
"display_name": "Kofi Mensah",
"hex_code": "AK-484-9321",
"lat": 5.6037,
"lng": -0.187,
"label": "Blue gate opposite Goil, third house",
"notes": "string",
"compound": "Mensah compound",
"unit": "Shop 4",
"floor": "Ground floor",
"alert_email": "kofi@example.com",
"flood_alerts_on": true
}