Refresh address cache (PUBLIC)

Overview

Clear the forever-cached country / state / city reference lists so the next lookup rebuilds them. Pass country_code to scope the flush to a single country (only its state/city cache keys are forgotten). Omit it to also forget the global countries_list_v2 key and every state/city key. Public maintenance endpoint in the pre-login reference group.

Prerequisites

  • No authentication — this endpoint is public.

Base URL

EnvironmentURL
Productionhttps://production-api.shoutaboutus.com
Developmenthttps://development-api.shoutaboutus.com

Endpoint

POST /api/v1/address/refresh-cache

Authentication

  • No bearer token required.

  • Public — no auth. Lives in the reference group.

Rate limit

  • 100 requests/min per IP.

Query parameters

FieldTypeRequiredDescription
country_codestringOptionalMust be an existing country code. Scopes the flush to one country; omit to clear all address caches.

How it works

  • 200{ data: { message: 'Address caches refreshed.' } }.
  • 422country_code supplied but not a known country code.

Response

200 OK · 200

{
  "data": {
    "message": "Address caches refreshed."
  }
}

422 Unknown country code · 422

{
  "message": "The selected country code is invalid.",
  "errors": {
    "country_code": [
      "The selected country code is invalid."
    ]
  }
}

Errors

StatusMeaning
422Unknown country code
500Unexpected server error

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/address/refresh-cache?country_code=US" \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Did this page help you?