Skip to main content

Create company address

POST 
/v2/companies/:lookupKey/:lookupValue/addresses

Create a new address for a specific company with complete validation and business rule enforcement.

Key Features​

  • Flexible Company Lookup: Create address using internal ID or external source ID
  • Complete Address Validation: Validates all address components and business rules
  • Default Address Management: Automatically handles default address assignment
  • Source System Integration: Supports external system integration with source tracking

Business Rules​

  • Company must exist before address creation
  • Address type must be valid (delivery, invoice, etc.)
  • Postal code is required for address validation
  • Only one default address per type per company
  • Address code must be unique within company scope

Validation Rules​

  • Street address is required and must be non-empty
  • City, country and postal code are mandatory fields
  • Contact name fields have length restrictions
  • Email format validation when provided

Use Cases​

  • New Company Setup: Add initial addresses during company onboarding
  • Address Expansion: Add additional delivery or billing addresses
  • System Integration: Import addresses from external systems
  • Address Management: Create addresses through admin interfaces

Request​

Responses​

Address created successfully