Skip to content
KynectLocal Docs

Update brand SEO settings

PUT
/v1/brands/{brandId}/seo
 
curl --request PUT \
  --url https://kynectlocal-production.up.railway.app/v1/v1/brands/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/seo \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
brandId
required
string format: uuid

Brand identifier

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

Media type application/json
object
data
required
object
seo
required
object
id
required
string format: uuid
name
required
string
seoOrgName
required
string | null
seoOrgAlternateName
required
string | null
seoBusinessType
required
string | null
seoTitleSeparator
required
string | null
seoTitleTemplatePage
required
string | null
seoTitleTemplateLocation
required
string | null
seoTitleTemplatePost
required
string | null
seoDescTemplatePage
required
string | null
seoDescTemplateLocation
required
string | null
seoDescTemplatePost
required
string | null
seoOgDefaultImage
required
string | null
seoOgSiteName
required
string | null
seoTwitterCardType
required
string | null
seoFbVerification
required
string | null
seoGoogleVerification
required
string | null
seoBingVerification
required
string | null
seoRobotsTxt
required
string | null
seoNoindexLocations
required
boolean
seoCanonicalEnabled
required
boolean
seoSitemapEnabled
required
boolean
seoLlmtxtEnabled
required
boolean
seoLockTitle
required
boolean
seoLockDescription
required
boolean
seoLockOgImage
required
boolean
seoLockRobots
required
boolean
Example generated
{
  "data": {
    "seo": {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "seoOrgName": "example",
      "seoOrgAlternateName": "example",
      "seoBusinessType": "example",
      "seoTitleSeparator": "example",
      "seoTitleTemplatePage": "example",
      "seoTitleTemplateLocation": "example",
      "seoTitleTemplatePost": "example",
      "seoDescTemplatePage": "example",
      "seoDescTemplateLocation": "example",
      "seoDescTemplatePost": "example",
      "seoOgDefaultImage": "example",
      "seoOgSiteName": "example",
      "seoTwitterCardType": "example",
      "seoFbVerification": "example",
      "seoGoogleVerification": "example",
      "seoBingVerification": "example",
      "seoRobotsTxt": "example",
      "seoNoindexLocations": true,
      "seoCanonicalEnabled": true,
      "seoSitemapEnabled": true,
      "seoLlmtxtEnabled": true,
      "seoLockTitle": true,
      "seoLockDescription": true,
      "seoLockOgImage": true,
      "seoLockRobots": true
    }
  }
}

400

Section titled “400 ”

Validation error

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Section titled “401 ”

Unauthenticated

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Section titled “403 ”

Forbidden

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Section titled “404 ”

Not found

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

422

Section titled “422 ”

Unprocessable

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}