Update a domain

PUT

/api/domains/{domainId}

Authorization

headerX-API-Key<token>

API Key for programmatic access

Path Parameters

domainId*string

Request Body

application/json

body

displayName?string

Display name of the domain

name?string

Brand name associated with the domain

url?string

Domain URL

website?string

Domain website

description?string

Domain description

shortDescription?string

Short description

fullDescription?string

Full description

industry?string

Industry or market

market?string

Market the company operates in, as an ISO 3166-1 alpha-2 country code

keywords?array<string>

Target keywords

keyBrandAttributes?array<string>

Key brand attributes

primaryLanguageCode?string

Primary language of the domain, as an ISO 639-1 code

personas?array<string>

Personas for targeting

generatePrompts?boolean

If true, generate sentiment and alignment prompts atomically during creation. If prompt generation fails, domain creation is rolled back.

Defaultfalse

Response Body

Domain updated

application/json

response

id*string

Unique identifier for the company

displayName*string

Display name shown in lists and navigation

name*string

Company name used in analysis

website?string

Company website URL, set on admin responses only

url?string

Company website URL (alias for website field)

industry*string

Industry the company operates in

market*string

Market the company operates in, as an ISO 3166-1 alpha-2 country code

primaryLanguageCode?string

Primary ISO 639-1 language code (e.g. "en", "fr", "nl") — used as the default when no marketLanguageCodePairs[].languageCode applies.

shortDescription*string

Short description of the company

fullDescription*string

Full detailed description of the company

longDescription?string

Full detailed description of the company (alias for frontend)

objectives?string

Business objectives and goals of the company

alignmentPrompts*array<>

List of key brand attributes and their alignment prompts

globalAlignmentPrompts*array<>

List of global alignment prompts

scrapedKeywords?array<string>

Keywords scraped from the website

transactionalKeywords?array<string>

AI-generated transactional keywords for BoFu strategies

personas?array<string>

Personas for targeting

aliases?array<string>

Brand name aliases

ownedSources?array<string>

Domains the brand owns besides its website (blog, docs, regional sites); a citation of one counts as an owned citation

competitors?array<string>

List of competitors, set on admin responses only

competitorDetails?array<>

Detailed competitor information including websites

logo?string

Logo URL

organizationId*string

Organization ID this domain belongs to

createdAt*string

Creation timestamp

Formatdate-time

updatedAt*string

Last update timestamp

Formatdate-time

nextManualAnalysisAllowedAt?string

Next allowed timestamp for manual analysis trigger

Formatdate-time

lastReportDate?string

Date of the last generated report (from any topic visibility report)

Formatdate-time

sentimentPrompts?array<>

Sentiment prompts

marketLanguageCodePairs*array<>

Market/language code pairs

enabledFeatures*

Per-feature enable flags (admin-controlled). Disabled features are skipped by the pipeline and hidden in the user UI.

curl -X PUT 'https://api.getmint.ai/api/domains/string' \  -H 'Content-Type: application/json' \  -d '{}'

{  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  "displayName": "Nike",  "name": "Nike",  "website": "nike.com",  "url": "nike.com",  "industry": "Athletic Apparel",  "market": "US",  "primaryLanguageCode": "en",  "shortDescription": "A global leader in athletic footwear, apparel, and equipment.",  "fullDescription": "Nike, Inc. designs, develops, and markets athletic footwear, apparel, equipment, and accessories worldwide under the Nike, Jordan, and Converse brands.",  "longDescription": "Nike, Inc. designs, develops, and markets athletic footwear, apparel, equipment, and accessories worldwide under the Nike, Jordan, and Converse brands.",  "objectives": "Increase brand visibility in performance running and grow direct-to-consumer sales.",  "alignmentPrompts": [    {      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",      "market": "US",      "languageCode": "en",      "prompts": [        {          "id": "5c1f2e90-1a2b-4c3d-9e8f-0a1b2c3d4e5f",          "attribute": "innovative",          "prompt": "How innovative is Nike compared to competitors?",          "isActive": true,          "createdAt": "2026-05-25T10:30:00.000Z",          "updatedAt": "2026-05-25T10:30:00.000Z"        }      ]    }  ],  "globalAlignmentPrompts": [    {      "id": "7b2c3d4e-5f6a-4b8c-9d0e-1f2a3b4c5d6e",      "market": "US",      "languageCode": "en",      "prompts": [        {          "id": "8c3d4e5f-6a7b-4c9d-8e0f-2a3b4c5d6e7f",          "prompt": "Does Nike align with sustainability values?",          "isActive": true,          "createdAt": "2026-05-25T10:30:00.000Z",          "updatedAt": "2026-05-25T10:30:00.000Z"        }      ]    }  ],  "scrapedKeywords": [    "running shoes",    "sneakers",    "athletic wear"  ],  "transactionalKeywords": [    "buy nike air max",    "best running shoes for marathon"  ],  "personas": [    "Marathon runner",    "Casual sneaker collector"  ],  "aliases": [    "Nike Inc.",    "Nike Sportswear"  ],  "ownedSources": [    "blog.nike.com",    "nike.co.uk"  ],  "competitors": [    "Adidas",    "Puma"  ],  "competitorDetails": [    {      "name": "Adidas",      "website": "adidas.com"    },    {      "name": "Puma",      "website": "puma.com"    }  ],  "logo": "https://nike.com/logo.png",  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  "createdAt": "2026-05-25T10:30:00.000Z",  "updatedAt": "2026-05-25T10:30:00.000Z",  "nextManualAnalysisAllowedAt": "2026-05-26T10:30:00.000Z",  "lastReportDate": "2026-05-25T10:30:00.000Z",  "sentimentPrompts": [    {      "id": "9d4e5f6a-7b8c-4d0e-9f1a-3b4c5d6e7f8a",      "market": "US",      "languageCode": "en",      "prompts": [        {          "id": "ae5f6a7b-8c9d-4e1f-8a2b-4c5d6e7f8a9b",          "prompt": "What do customers think about Nike?",          "isActive": true,          "createdAt": "2026-05-25T10:30:00.000Z",          "updatedAt": "2026-05-25T10:30:00.000Z"        }      ]    }  ],  "marketLanguageCodePairs": [    {      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",      "market": "US",      "languageCode": "en"    }  ],  "enabledFeatures": {    "sentiment": true,    "alignment": true  }}

PUT

/api/domains/{domainId}

Authorization

headerX-API-Key<token>

API Key for programmatic access

Path Parameters

domainId*string

Request Body

application/json

body

displayName?string

Display name of the domain

name?string

Brand name associated with the domain

url?string

Domain URL

website?string

Domain website

description?string

Domain description

shortDescription?string

Short description

fullDescription?string

Full description

industry?string

Industry or market

market?string

Market the company operates in, as an ISO 3166-1 alpha-2 country code

keywords?array<string>

Target keywords

keyBrandAttributes?array<string>

Key brand attributes

primaryLanguageCode?string

Primary language of the domain, as an ISO 639-1 code

personas?array<string>

Personas for targeting

generatePrompts?boolean

If true, generate sentiment and alignment prompts atomically during creation. If prompt generation fails, domain creation is rolled back.

Defaultfalse

Response Body

Domain updated

application/json

response

id*string

Unique identifier for the company

displayName*string

Display name shown in lists and navigation

name*string

Company name used in analysis

website?string

Company website URL, set on admin responses only

url?string

Company website URL (alias for website field)

industry*string

Industry the company operates in

market*string

Market the company operates in, as an ISO 3166-1 alpha-2 country code

primaryLanguageCode?string

Primary ISO 639-1 language code (e.g. "en", "fr", "nl") — used as the default when no marketLanguageCodePairs[].languageCode applies.

shortDescription*string

Short description of the company

fullDescription*string

Full detailed description of the company

longDescription?string

Full detailed description of the company (alias for frontend)

objectives?string

Business objectives and goals of the company

alignmentPrompts*array<>

List of key brand attributes and their alignment prompts

globalAlignmentPrompts*array<>

List of global alignment prompts

scrapedKeywords?array<string>

Keywords scraped from the website

transactionalKeywords?array<string>

AI-generated transactional keywords for BoFu strategies

personas?array<string>

Personas for targeting

aliases?array<string>

Brand name aliases

ownedSources?array<string>

Domains the brand owns besides its website (blog, docs, regional sites); a citation of one counts as an owned citation

competitors?array<string>

List of competitors, set on admin responses only

competitorDetails?array<>

Detailed competitor information including websites

logo?string

Logo URL

organizationId*string

Organization ID this domain belongs to

createdAt*string

Creation timestamp

Formatdate-time

updatedAt*string

Last update timestamp

Formatdate-time

nextManualAnalysisAllowedAt?string

Next allowed timestamp for manual analysis trigger

Formatdate-time

lastReportDate?string

Date of the last generated report (from any topic visibility report)

Formatdate-time

sentimentPrompts?array<>

Sentiment prompts

marketLanguageCodePairs*array<>

Market/language code pairs

enabledFeatures*

Per-feature enable flags (admin-controlled). Disabled features are skipped by the pipeline and hidden in the user UI.

curl -X PUT 'https://api.getmint.ai/api/domains/string' \  -H 'Content-Type: application/json' \  -d '{}'

{  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  "displayName": "Nike",  "name": "Nike",  "website": "nike.com",  "url": "nike.com",  "industry": "Athletic Apparel",  "market": "US",  "primaryLanguageCode": "en",  "shortDescription": "A global leader in athletic footwear, apparel, and equipment.",  "fullDescription": "Nike, Inc. designs, develops, and markets athletic footwear, apparel, equipment, and accessories worldwide under the Nike, Jordan, and Converse brands.",  "longDescription": "Nike, Inc. designs, develops, and markets athletic footwear, apparel, equipment, and accessories worldwide under the Nike, Jordan, and Converse brands.",  "objectives": "Increase brand visibility in performance running and grow direct-to-consumer sales.",  "alignmentPrompts": [    {      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",      "market": "US",      "languageCode": "en",      "prompts": [        {          "id": "5c1f2e90-1a2b-4c3d-9e8f-0a1b2c3d4e5f",          "attribute": "innovative",          "prompt": "How innovative is Nike compared to competitors?",          "isActive": true,          "createdAt": "2026-05-25T10:30:00.000Z",          "updatedAt": "2026-05-25T10:30:00.000Z"        }      ]    }  ],  "globalAlignmentPrompts": [    {      "id": "7b2c3d4e-5f6a-4b8c-9d0e-1f2a3b4c5d6e",      "market": "US",      "languageCode": "en",      "prompts": [        {          "id": "8c3d4e5f-6a7b-4c9d-8e0f-2a3b4c5d6e7f",          "prompt": "Does Nike align with sustainability values?",          "isActive": true,          "createdAt": "2026-05-25T10:30:00.000Z",          "updatedAt": "2026-05-25T10:30:00.000Z"        }      ]    }  ],  "scrapedKeywords": [    "running shoes",    "sneakers",    "athletic wear"  ],  "transactionalKeywords": [    "buy nike air max",    "best running shoes for marathon"  ],  "personas": [    "Marathon runner",    "Casual sneaker collector"  ],  "aliases": [    "Nike Inc.",    "Nike Sportswear"  ],  "ownedSources": [    "blog.nike.com",    "nike.co.uk"  ],  "competitors": [    "Adidas",    "Puma"  ],  "competitorDetails": [    {      "name": "Adidas",      "website": "adidas.com"    },    {      "name": "Puma",      "website": "puma.com"    }  ],  "logo": "https://nike.com/logo.png",  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  "createdAt": "2026-05-25T10:30:00.000Z",  "updatedAt": "2026-05-25T10:30:00.000Z",  "nextManualAnalysisAllowedAt": "2026-05-26T10:30:00.000Z",  "lastReportDate": "2026-05-25T10:30:00.000Z",  "sentimentPrompts": [    {      "id": "9d4e5f6a-7b8c-4d0e-9f1a-3b4c5d6e7f8a",      "market": "US",      "languageCode": "en",      "prompts": [        {          "id": "ae5f6a7b-8c9d-4e1f-8a2b-4c5d6e7f8a9b",          "prompt": "What do customers think about Nike?",          "isActive": true,          "createdAt": "2026-05-25T10:30:00.000Z",          "updatedAt": "2026-05-25T10:30:00.000Z"        }      ]    }  ],  "marketLanguageCodePairs": [    {      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",      "market": "US",      "languageCode": "en"    }  ],  "enabledFeatures": {    "sentiment": true,    "alignment": true  }}

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Update a domain

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Path Parameters

Request Body

Response Body

Authorization

Path Parameters

Request Body

Response Body