Skip to content
SynupAPI
Get an API key
POSTapi.synup.com/api/v4/local-post-ideas/set-location-image-credits

Set location image credits

Sets the monthly image-generation credit limit for a location and whether image-credit metering is active. Returns the updated credit status.

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
monthlyLimitintegeroptional
isActivebooleanoptional

Request

Request
curl -X POST 'https://api.synup.com/api/v4/local-post-ideas/set-location-image-credits' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "locationId": "TG9jYXRpb246MQ==",
  "monthlyLimit": 100,
  "isActive": true
}'

Responses

StatusDescription
200Successful response
401Unauthorized - Invalid or missing API key
Example response (generated from the schema)
{
  "data": {
    "setLocationImageCredits": {
      "locationId": "string",
      "monthlyLimit": 0,
      "isActive": true,
      "usedThisMonth": 0,
      "remainingThisMonth": 0,
      "addonPurchased": 0,
      "addonConsumed": 0,
      "addonRemaining": 0
    }
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.setLocationImageCreditsobjectoptional
data.setLocationImageCredits.locationIdstringoptional
data.setLocationImageCredits.monthlyLimitintegeroptional
data.setLocationImageCredits.isActivebooleanoptional
data.setLocationImageCredits.usedThisMonthintegeroptional
data.setLocationImageCredits.remainingThisMonthintegeroptional
data.setLocationImageCredits.addonPurchasedintegeroptional
data.setLocationImageCredits.addonConsumedintegeroptional
data.setLocationImageCredits.addonRemainingintegeroptional