Competitor AdsSave the brand profile

Save the brand profile

Replaces the client's brand profile. Ad prompt generation uses it when no brand is sent. Agency keys or competitor_ads:write.

curl -X PUT "https://mythic-analytics.gulp.workers.dev/client/v1/competitor-ads/brand?location_id=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "product": "example_string",
  "audience": "example_string",
  "benefits": [
    "example_string"
  ],
  "angles": [
    "example_string"
  ],
  "proof": [
    "example_string"
  ],
  "offers": [
    "example_string"
  ],
  "must_avoid": [
    "example_string"
  ],
  "compliance": "example_string"
}'
{
  "success": true,
  "data": {
    "brand": {
      "product": "example_string",
      "audience": "example_string",
      "benefits": [
        "example_string"
      ],
      "angles": [
        "example_string"
      ],
      "proof": [
        "example_string"
      ],
      "offers": [
        "example_string"
      ],
      "must_avoid": [
        "example_string"
      ],
      "compliance": "example_string"
    },
    "updated_at": "2024-12-25T10:00:00Z"
  }
}
PUT
/client/v1/competitor-ads/brand
PUT
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Agency key (ak_), location secret key (sk_, reads only) or a scoped mcp_ key with competitor_ads:read or competitor_ads:write. See Using an mcp_ key over HTTP.

Agency key (ak_), location secret key (sk_, reads only) or a scoped mcp_ key with competitor_ads:read or competitor_ads:write. See Using an mcp_ key over HTTP.
query
location_idstring

Location to scope to. Required for ak_ keys or send X-Location-Id. Ignored for sk_.

Content-Typestring
Required

The media type of the request body

Options: application/json
productstring
Required

What the client sells.

Max length: 300
audiencestring
Max length: 600
proofarray

Proof prompts may cite. They never claim more than this.

compliancestring
Max length: 1500
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Agency key (ak_), location secret key (sk_, reads only) or a scoped mcp_ key with competitor_ads:read or competitor_ads:write. See Using an mcp_ key over HTTP.

Query Parameters

location_idstring

Location to scope to. Required for ak_ keys or send X-Location-Id. Ignored for sk_.

Body

application/json
productstring
Required

What the client sells.

proofarray

Proof prompts may cite. They never claim more than this.

Responses

successboolean
dataobject