business_locations

enable_business_location_with_all_counties

POST

/api/v2/business_locations/enable_business_location_with_all_counties

Enable a business location and auto-populate all counties for that state. Parameters ---------- locationId : str, required The ID of the business location to enable country : str, optional Country code ('US' or 'CA'), defaults to 'US' Returns ------- success : bool True if successful message : str Success or error message data : dict Updated location with counties

enable_business_location_with_all_counties › Request Body

Request payload for /api/v2/business_locations/enable_business_location_with_all_counties

request-enable_business_location_with_all_counties

location_id

string · uuid · required

The ID of the business location to enable

country

string · enum

Country code ('US' or 'CA'), defaults to 'US'

Enum values:

enable_business_location_with_all_counties › Responses

200

Response payload for /api/v2/business_locations/enable_business_location_with_all_counties

response-enable_business_location_with_all_counties

required

object · required

Business location with all counties enabled

success

boolean · required

Whether the operation was successful

POST/api/v2/business_locations/enable_business_location_with_all_counties

curl --request POST \
  --url /api/v2/business_locations/enable_business_location_with_all_counties \
  --header 'Content-Type: application/json' \
  --data '
{
  "location_id": "00000000-0000-0000-0000-000000000000",
  "country": "US"
}
'

Example Request Body

{
  "location_id": "00000000-0000-0000-0000-000000000000",
  "country": "US"
}

json

Example Responses

{
  "messages": [
    "string"
  ],
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "abbreviation": "abbreviation",
    "name": "name",
    "counties": [
      {
        "name": "name",
        "fips": "fips"
      }
    ],
    "life_cycle_parameters": "life_cycle_parameters",
    "checked": true
  },
  "success": true
}

json

application/json

retrieve_business_locations

POST

/api/v2/business_locations/retrieve_business_locations

The states the site writes in (checked business locations), by name, each with its counties.

Code
What the contact Assignments page reads from classic's gateway retrieveBusinessLocations: the states it
offers and the counties of each.

Returns
-------
data : list of dict
    ``[{"id": str, "name": str, "abbreviation": str, "counties": [{"id": str, "code": str, "name": str}]}]``

retrieve_business_locations › Request Body

Request schema for /api/v2/business_locations/retrieve_business_locations. Takes no parameters.

request-business_locations_retrieve_business_locations

retrieve_business_locations › Responses

200

Response schema for /api/v2/business_locations/retrieve_business_locations: the states the site writes in (checked business locations), by name, each with every county it holds, as classic's gateway retrieveBusinessLocations sends them to the contact Assignments page. Needs britecore (r).

response-business_locations_retrieve_business_locations

object[]

brands claim_adjuster_assignment_configs