Add Competitor

POST

/competitor

Adds a public social media profile as a competitor in your workspace.

Use GET /search/profiles first to find the target profile and obtain its id, then pass that value as profileId in the request body.

If the profile is already tracked as a competitor in your workspace, the request is idempotent — it returns the existing competitor record without creating a duplicate.

Adding a competitor will trigger background data collection for that profile.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Bodyapplication/json

🟠403Plan limit reached

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.swonkie.dev/v2/competitor' \
--header 'X-API-ID: ' \
--header 'X-API-KEY: ' \
--header 'Content-Type: application/json' \
--data '{
    "profileId": "UHJ0ZXdEWnMxV2ppVFNISDlZZlRWdz09"
}'

Response Example

201 - 201 Created

{
    "id": "d3hQY09Bc0hUUDhQbElKRUhldGN2dz09",
    "profileId": "UHJ0ZXdEWnMxV2ppVFNISDlZZlRWdz09"
}

Modified at 2026-06-22 10:56:00

Competitors

Delete Competitor