Skip to main content
POST
/
agents
/
{agentId}
/
geocode-roster
Error
A valid request URL is required to generate request examples
{
  "success": true,
  "data": {
    "entries": [
      {
        "address": "<string>",
        "lat": 123,
        "lng": 123,
        "geocoded": true,
        "label": "<string>",
        "phone": "<string>",
        "formatted": "<string>"
      }
    ],
    "geocoded": 123,
    "failed": 123
  },
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

Path Parameters

agentId
string
required

Body

application/json
entries
object[]
required

Roster rows to geocode. Capped per request; chunk a larger import.

Response

The roster rows enriched with coordinates.

success
boolean
required
data
object
required
message
string
errors
object[]