API reference / CRM
Add local businesses to a list
Adds places POST /places/search found to a list of companies: one company each, found again by Overture's id or its domain, with its name, website, phone, address and category, recorded as coming from Overture Maps. A place already on the list is updated.
post
/api/v1/lists/{id}/placesOther ways to call it
CLI
troopy lists add-placesMCP tool
troopy_add_list_placesRate limit60 calls in 60 seconds, for each key
RetriesSend an
Idempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Path parameters
id*stringA 24-character id
Body
application/jsonplaces*array<object>At most 200 items
9 properties
id*stringAt least 1 characters · At most 100 characters
name*stringAt least 1 characters · At most 200 characters
websitestring | nullphonestring | nulladdressstring | nullcitystring | nullregionstring | nullcountrystring | nullcategorystring | nullResponse
200 · application/jsondata*object3 properties
added*integerupdated*integerskipped*integerErrors
400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
404 not_foundCheck the path and any id in it. Every operation is listed in /api/v1/openapi.json.
409 conflictThis Idempotency-Key was used for a different request, or that request is still running. Use a new key for a new request.
429 rate_limitedWait the number of seconds in Retry-After, then retry.