Skip to content
SynupAPI
Get an API key
POSTapi.synup.com/api/v4/local-post-ideas/upsert-extended-location-config

Upsert extended location config

Creates or updates the extended generation config for a location — brand tone, target customers, contact/address, brand colors and logos, and the services/products/content-rules that ground post-idea generation. Only the fields you send are changed. services, products, and contentRules are JSON values.

Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Headers

NameTypeRequiredDescription
Synup-VersionstringrequiredAPI version date (YYYY-MM-DD).

Body

NameTypeRequiredDescription
locationIdstringrequired
tonestringoptional
targetCustomersstringoptional
countrystringoptional
phonestringoptional
addressstringoptional
locationstringoptional
primaryColorstringoptional
secondaryColorstringoptional
logoLightstringoptional
logoDarkstringoptional
servicesobjectoptionalFree-form JSON describing services.
productsobjectoptionalFree-form JSON describing products.
contentRulesobjectoptionalFree-form JSON content rules.
additionalContextstringoptional

Request

Request
curl -X POST 'https://api.synup.com/api/v4/local-post-ideas/upsert-extended-location-config' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "locationId": "TG9jYXRpb246MQ==",
  "tone": "friendly",
  "targetCustomers": "families"
}'

Responses

StatusDescription
200Successful response
401Unauthorized - Invalid or missing API key
Example response (generated from the schema)
{
  "data": {
    "upsertExtendedLocationConfig": {
      "success": true,
      "error": {
        "message": "string",
        "code": "string",
        "contextInfo": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      }
    }
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.upsertExtendedLocationConfigobjectoptional
data.upsertExtendedLocationConfig.successbooleanoptional
data.upsertExtendedLocationConfig.errorobjectoptional
data.upsertExtendedLocationConfig.error.messagestringoptional
data.upsertExtendedLocationConfig.error.codestringoptional
data.upsertExtendedLocationConfig.error.contextInfoarray of objectoptional
data.upsertExtendedLocationConfig.error.contextInfo[].keystringoptional
data.upsertExtendedLocationConfig.error.contextInfo[].valuestringoptional