aVenture APIEntity Maintenance

Set entity typeRecord

View as Markdown
Sets one entity's typeRecord from a concrete EntityType value or accepted alias. For single-slug entity routes, when the typeRecord changes the public route prefix, the server automatically redirects the actual prior public path for the unchanged slug to the new canonical public path, retargets existing upstream redirect chains, and removes any redirect whose source is now canonical. When setting Product or Service and no current provider relationship exists, set productServiceProviderId so the productService relationship is created in the same transaction. Product/Service nameBrand must not exactly match the provider; eponymous offerings without a distinct brand should use a descriptor/category such as Consumer Sedans or Light Industrial Vehicles. Organization is group-only and is rejected as an individual typeRecord. Use GET /v1/entities/types to inspect writable values, meanings, and aliases.

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

Query parameters

productServiceProviderIdstringOptionalformat: "uuid"
Existing provider entity UUID required when setting typeRecord to Product or Service and the row has no current productService provider join. Use this to repair or move the provider atomically instead of clearing the join.
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.

Request

This endpoint expects an object.
allowSuspectedShellStripboolean or nullOptional

Allow intentional money-like text without a currency marker; prefer —from-file.

defaultCurrencystring or nullOptional
Default operating currency.
foundedYearinteger or nullOptional
Year founded.
nameAliaslist of objects or nullOptional
Alternative or former names used for search and display. When supplied, the list replaces existing aliases.
nameBrandstring or nullOptional

Brand name. For Product or Service records, this must name a distinct offering and must not exactly match the joined provider entity. If an eponymous offering has no distinct product-line brand, use a descriptor/category such as Consumer Sedans or Light Industrial Vehicles instead.

nameLegalstring or nullOptional
Legal name.
newSlugstring or nullOptional

Preferred detail-update slug rename field. Omit on create; when slug is also sent both fields must normalize to the same value.

operatingStatusenum or nullOptional

Operating status. Required on create; omitted update values preserve existing status. Use Acquired Subsidiary when an acquired entity still operates; use Acquired only when it is terminal, folded, or closed. Closed and terminal Acquired keep attached person joins current; update association endDate separately with a closing-date estimate.

slugstring or nullOptional

Entity URL slug. Create may omit it when the server can derive one; detail updates may rename through this field or newSlug. Company-class slugs are one shared namespace and must end with the HQ location suffix (brand-city-state-country); a held slug returns 409. Product and Service slugs derive from nameBrand, stay scoped to the provider pair, and may repeat across providers; reusing a slug under the same provider or one held by a non-product entity returns 409.

statusobject or nullOptional

Visibility and verification flags; omitted update fields preserve existing values.

typeRecordstring or nullOptional

Concrete entity type such as Company, Investment Firm, Product, or Service. Product and Service records always pair with a current productService provider relationship: creates write the join atomically via productServiceProviderId, the sole provider join cannot be removed or re-pointed, and moving an offering to a different provider means delete and recreate.

Response

OK

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
406
Not Acceptable Error
409
Conflict Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error