API reference · Clients
POST/api/v1/clients/{id}/locations

Create client location

Creates a location row for client_id after validation and client existence check.

RBAC · client

Path parameters

idstring <uuid>Required

Request body

Content type: application/json · schema ClientLocationBody

location_namestring
address_line1stringRequired
min length 1
address_line2string
address_line3string
citystringRequired
min length 1
state_provincestring
postal_codestring
country_codestringRequired
min length 2 · max length 3
country_namestringRequired
min length 1
region_codestring
is_billing_addressboolean
is_shipping_addressboolean
is_defaultboolean
phonestring
faxstring
emailstring <email>
notesstring
is_activeboolean

Response body

Success response 201 · schema ClientLocationEnvelope

dataobjectRequired
location_idstring <uuid>Required
client_idstring <uuid>Required
location_namestringRequiredNullable
address_line1stringRequired
address_line2stringRequiredNullable
address_line3stringRequiredNullable
citystringRequired
state_provincestringRequiredNullable
postal_codestringRequiredNullable
country_codestringRequired
country_namestringRequired
region_codestringRequiredNullable
is_billing_addressbooleanRequired
is_shipping_addressbooleanRequired
is_defaultbooleanRequired
phonestringRequiredNullable
faxstringRequiredNullable
emailstringRequiredNullable
notesstringRequiredNullable
is_activebooleanRequired
created_atstring <date-time>Required
updated_atstring <date-time>Required
tenantstring <uuid>Required
metaobject

Response codes

201
Client location created.
400
Invalid client id or request payload.
401
API key missing/invalid or key user not found.
403
Permission denied for client update.
404
Client not found.
500
Unexpected client location creation failure.