COMPANY

Creates a new address for a specific company.

POST/api/v2/companies/{companyId}/addresses

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Parameters

companyIdpathinteger · int32required

The company to add the address to.

Request body

application/jsonrequired

Address details.

descriptionstringrequired
address1stringnullable
address2stringnullable
citystringnullable
statestringnullable
zipstringnullable
countystringnullable
countrystringnullable
mailingbooleannullable
mappingbooleannullable

Responses

Company address created successfully.

Standard response envelopeisSuccessmessageerrorsdata

Read the result from data. When isSuccess is false, errors lists what went wrong. Handling errors

addressIdinteger · int32
companyIdinteger · int32
descriptionstring
address1string
address2string
address3string
citystring
statestring
zipstring
countystring
countrystring
longitudenumber · double
latitudenumber · double
mailingboolean
mappingboolean
linkedboolean

REQUEST EXAMPLE

curl --request POST \
  'https://apiv2.crmseries.com/api/v2/companies/COMPANY_ID/addresses' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": "string",
    "address1": "100 Main St",
    "address2": "100 Main St",
    "city": "Chicago",
    "state": "IL",
    "zip": "60601",
    "county": "Cook",
    "country": "US",
    "mailing": true,
    "mapping": true
  }'

Replace the uppercase placeholders and sample values with your integration values.

RESPONSE · 201

{
  "isSuccess": true,
  "message": "",
  "data": {
    "addressId": 1024,
    "companyId": 1024,
    "description": "string",
    "address1": "100 Main St",
    "address2": "100 Main St",
    "address3": "100 Main St",
    "city": "Chicago",
    "state": "IL",
    "zip": "60601",
    "county": "Cook",
    "country": "US",
    "longitude": -87.6298,
    "latitude": 41.8781,
    "mailing": true,
    "mapping": true,
    "linked": true
  },
  "errors": []
}