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

Set brand image credits

Sets the monthly image-generation credit limit for a brand (social profile) and whether image-credit metering is active.

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

Request

Request
curl -X POST 'https://api.synup.com/api/v4/social-post-ideas/set-brand-image-credits' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "socialProfileId": "6f1c2a90-...",
  "monthlyLimit": 100,
  "isActive": true
}'

Responses

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

Response body

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