Skip to content
ZUTAX ZUTAX Documentation

Add address to party

POST
/api/v1/tenants/{tenant_id}/workspaces/{workspace_id}/parties/{party_id}/addresses

Add a new address to a party.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
party_id
required
Party Id
string format: uuid

Header Parameters

Section titled “Header Parameters ”
X-Workspace-ID
Any of:
string
X-API-Key
Any of:
string
X-Tenant-ID
Any of:
string

Request Body required

Section titled “Request Body required ”
AddressCreate

Create address schema.

object
address_type
Address Type
string
default: postal <= 20 characters
street_name
Any of:
string
<= 500 characters
additional_street_name
Any of:
string
<= 500 characters
building_number
Any of:
string
<= 50 characters
city_name
required
City Name
string
<= 100 characters
postal_zone
Any of:
string
<= 20 characters
state
Any of:
string
<= 100 characters
lga
Any of:
string
<= 200 characters
country_code
required
Country Code

ISO 3166-1 alpha-2

string
<= 2 characters
department
Any of:
string
<= 200 characters
po_box
Any of:
string
<= 50 characters
is_primary
Is Primary
boolean
Examples

Request payload example

{
  "address_type": "postal",
  "street_name": "string",
  "additional_street_name": "string",
  "building_number": "string",
  "city_name": "string",
  "country_code": "string"
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful Response

Examples

201 response example

{
  "status": "ok",
  "message": "Request completed successfully."
}

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examples

422 response example

{
  "detail": [
    {
      "loc": [],
      "msg": "string",
      "type": "string"
    }
  ]
}