aVenture APIEntity Addresses Canonical

Delete entity address

View as Markdown

Soft-delete by default (flips isCurrent=false on every role association for the physical address while preserving roles). Pass deleteMode=hard to drop that whole association group. The address record itself is never deleted; it stays on disk for audit.

Authentication

AuthorizationBearer

User bearer token: Supabase or Clerk session JWT, Clerk OAuth access token, or Clerk personal API key

OR
X-API-Keystring

Admin API key for system-to-system write operations

Path parameters

entityIdstringRequiredformat: "uuid"
Canonical entity UUID
addressJoinIdintegerRequired
Address join id parameter

Query parameters

deleteModeenumOptional
Delete mode parameter
Allowed values:
sourceTypeenumRequired
Write provenance source type.
sourceDetailstringRequired
Source detail or reviewer reference for the write.
sourceProviderstringOptional

Provider name for provider-native IDs or slugs.

sourceProviderIdstringOptional

Provider-native source ID.

sourceProviderSlugstringOptional

Provider-native source slug.

actorTypeenumOptional

Actor type; inferred as agent when agentChassis and agentModel are supplied, or as employee from an authenticated user JWT session.

Allowed values:
agentChassisstringOptional

Agent chassis token for agent-authored writes.

agentModelstringOptional

Agent model id for agent-authored writes.

Response

OK
addressinteger or nullOptional
Legacy address row identifier
addressLine1string or nullOptional
addressLine2string or nullOptional
associationlist of objectsOptional

Role-period associations for this physical address

cityobject or nullOptional
City reference
countryobject or nullOptional
Country reference
countryAbbrevstring or nullOptional
createdAtdatetime or nullOptional
fullAddressstring or nullOptional

Single-line formatted address

idinteger or nullOptional
Address record identifier
latitudedouble or nullOptional
longitudedouble or nullOptional
postalCodestring or nullOptional
stateobject or nullOptional
State or region reference
stateAbbrevstring or nullOptional
streetstring or nullOptional
updatedAtdatetime or nullOptional
isCurrentboolean or nullOptionalDeprecated

Deprecated aggregate compatibility flag; true when any association is current

isHqboolean or nullOptionalDeprecated

Deprecated legacy flag marking the headquarters or legal/registered address

isPrimaryboolean or nullOptionalDeprecated
Deprecated legacy flag marking the primary display address

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
406
Not Acceptable Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error