---
title: "Scrape brand"
method: POST
path: "/social-post-ideas/scrape-brand"
tags: ["Social Post Ideas"]
---

# Scrape brand

`POST /social-post-ideas/scrape-brand`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/social-post-ideas/scrape-brand`
- Auth: none required
- TypeScript: <https://skmtc.dev/synup/apis/synup-api/docs/social-post-ideas/scrape-brand/post.ts> (a function with typed inputs; its response is checked against the schema)

Triggers a scrape of the brand's website to refresh the context used for social post-idea generation. Provide the `siteUrl` to scrape; `trigger` optionally records what initiated the scrape.

## Headers

- `Synup-Version` string, required
- `Authorization` string, required

## Request body

- ScrapeBrandRequest
  - `socialProfileId` string, required
  - `siteUrl` string, required
  - `trigger` string

## Response `200`

Successful response

- object
  - `data` object
    - `scrapeBrand` MutationResponse
      - `success` boolean
      - `error` Error
        - `message` string
        - `code` string
        - `contextInfo` object[]
          - `key` string
          - `value` string

## Other responses

- `401`: Unauthorized - Invalid or missing API key

---

[API](https://skmtc.dev/synup/apis/synup-api.md) - [All operations](https://skmtc.dev/synup/apis/synup-api/llms.txt) - [OpenAPI document](https://skmtc.dev/synup/apis/synup-api/revisions/67de2d51c22e?raw)