Skip to content
UltimateTeam.ai Docs

Configure Competitor

PUT
/api/v1/intelligence/battlecards
curl --request PUT \
  --url https://api.ultimateteam.ai/api/v1/intelligence/battlecards \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "career_urls": [ "https://example.com" ], "competitor_name": "example", "competitor_urls": [ "https://example.com" ], "features_urls": [ "https://example.com" ], "messaging_urls": [ "https://example.com" ], "reviews_urls": [ "https://example.com" ] }'

Store owner URLs consumed by native monitoring; saving does not start a crawl.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
CompetitorConfiguration
object
career_urls
Career Urls
Array<string>
<= 2 items
competitor_name
required
Competitor Name
string
>= 1 characters <= 500 characters
competitor_urls
required
Competitor Urls
Array<string>
<= 3 items
features_urls
Features Urls
Array<string>
<= 3 items
messaging_urls
Messaging Urls
Array<string>
<= 3 items
reviews_urls
Reviews Urls
Array<string>
<= 3 items
Examplegenerated
{
  "career_urls": [
    "https://example.com"
  ],
  "competitor_name": "example",
  "competitor_urls": [
    "https://example.com"
  ],
  "features_urls": [
    "https://example.com"
  ],
  "messaging_urls": [
    "https://example.com"
  ],
  "reviews_urls": [
    "https://example.com"
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
BattlecardResponse
object
career_urls
required
Career Urls
Array<string>
competitor_name
required
Competitor Name
string
competitor_urls
required
Competitor Urls
Array<string>
hiring
required
Any of:
object
key
additional properties
any
id
required
Id
string format: uuid
last_scanned_at
required
Any of:
string format: date-time
pricing
required
Any of:
object
key
additional properties
any
source_config
required
Source Config
object
key
additional properties
Array<string>
Examplegenerated
{
  "career_urls": [
    "example"
  ],
  "competitor_name": "example",
  "competitor_urls": [
    "example"
  ],
  "hiring": {},
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "last_scanned_at": "2026-04-15T12:00:00Z",
  "pricing": {},
  "source_config": {
    "additionalProperty": [
      "example"
    ]
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}