Skip to main content

Company Bulk Addresses

POST 

/companies/:lookupKey/:lookupValue/addresses/bulk

Use this endpoint to create multiple company addresses with a single API request. If an address with the code provided is found, it will be updated, otherwise a new address will be created. If the code is not provided, a new address will be created. When a new address is successfully created, the response will include the address id.

Fields

NameRequired
typeyes
codeyes
firstNameno
middleNameno
lastNameno
genderno
Default is U
streetyes
numberno
numberExtensionno
postalCodeno
cityyes
countryyes
regionno
icpno

Default is N
phoneno
mobileno
emailno
companyno
urlno
isDefaultno

Default is N
notesno

Request

Path Parameters

    lookupKey stringrequired

    Lookup key. Read more about company lookup keys

    lookupValue stringrequired

    The value of the key (id or sourceId)

Body

    addresses

    object[]

  • Array [

  • city string
    code string
    company string
    country string
    email string
    firstName string
    icp string
    isDefault string
    lastName string
    middleName string
    mobile string
    notes string
    number string
    numberExtension string
    phone string
    postalCode string
    region string
    street string
    type string
    url string
  • ]

Responses

Company Bulk Addresses - 200

Response Headers

  • Alt-Svc

    string

  • Via

    string

  • alt-svc

    string

  • content-length

    string

  • date

    string

  • return-format

    string

  • x-request-id

    string

Schema

    data

    object[]

  • Array [

  • action string
    id number
    key string
    lookupKey string
    success boolean
  • ]

  • messages string[]
    total number
Loading...