Set the calling tenant's research brief (description + optional website/appStoreUrl/competitors seeds)

Authorization

bearerAuth

AuthorizationBearer <token>

ViralQuery API key. Send it only to https://api.viralquery.com in the Authorization: Bearer header.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description*string

Length1 <= length <= 20000

website?string

Public HTTPS website URL; private, loopback, credentialed, and non-HTTPS URLs are rejected.

Formaturi

Lengthlength <= 2048

appStoreUrl?string

Public Apple App Store HTTPS URL containing a numeric app ID.

Formaturi

Lengthlength <= 2048

competitors?array<>

Itemsitems <= 20

name?string

Length1 <= length <= 200

url?stringDeprecated

Deprecated compatibility alias. Must be a public HTTPS website or Apple App Store URL with a numeric app ID; send website or appStoreUrl instead.

Formaturi

Lengthlength <= 2048

website*string

Formaturi

Lengthlength <= 2048

description?string

Length1 <= length <= 20000

appStoreUrl?string

Public Apple App Store HTTPS URL containing a numeric app ID.

Formaturi

Lengthlength <= 2048

competitors?array<>

Itemsitems <= 20

name?string

Length1 <= length <= 200

url?stringDeprecated

Deprecated compatibility alias. Must be a public HTTPS website or Apple App Store URL with a numeric app ID; send website or appStoreUrl instead.

Formaturi

Lengthlength <= 2048

appStoreUrl*string

Formaturi

Lengthlength <= 2048

description?string

Length1 <= length <= 20000

website?string

Public HTTPS website URL; private, loopback, credentialed, and non-HTTPS URLs are rejected.

Formaturi

Lengthlength <= 2048

competitors?array<>

Itemsitems <= 20

name?string

Length1 <= length <= 200

url?stringDeprecated

Deprecated compatibility alias. Must be a public HTTPS website or Apple App Store URL with a numeric app ID; send website or appStoreUrl instead.

Formaturi

Lengthlength <= 2048

url*stringDeprecated

Formaturi

Lengthlength <= 2048

description?string

Length1 <= length <= 20000

website?string

Public HTTPS website URL; private, loopback, credentialed, and non-HTTPS URLs are rejected.

Formaturi

Lengthlength <= 2048

appStoreUrl?string

Public Apple App Store HTTPS URL containing a numeric app ID.

Formaturi

Lengthlength <= 2048

competitors?array<>

Itemsitems <= 20

name?string

Length1 <= length <= 200

Set the calling tenant's research brief (description + optional website/appStoreUrl/competitors seeds)

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Set the calling tenant's research brief (description + optional website/appStoreUrl/competitors seeds)

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

402application/json

403application/json

409application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`