Skip to main content
POST
Create entity address
SystemUser accessible. Required policy actions:
  • AddressService:createAddress

Authorizations

Authorization
string
header
required

JWT bearer token obtained from POST /auth/system-login using your client credentials.

Path Parameters

id
string
required

Entity ID

Body

application/json

State is optional and independent of Country - an address can be created with only a Country and no State/province. Either StateId/CountryId (direct IDs) or the nested State/Country objects (resolved by name) may be used.

address1
string
required
Example:

"123 Main St"

city
string
required
Example:

"Bengaluru"

zip
string
required
Example:

"560001"

address2
string
Example:

"Suite 200"

taxId
string
Example:

"29ABCDE1234F1Z5"

StateId
string

Optional. Omit if the address only has a Country.

Example:

"sta_1a2b3c4d"

CountryId
string

Optional, but recommended - a Country can be set independently of State.

Example:

"cou_1a2b3c4d"

State
object

Alternative to StateId - resolves the state (and its Country) by name instead of ID.

Country
object

Alternative to CountryId - resolves the Country by name. Used when the address has no State at all.

Response

Success

status
string
Example:

"success"

message
string
Example:

"Success"

data
object | null

Endpoint-specific payload (object, array, or null)