Skip to main content
PATCH
Change the SEO rules

Authorizations

Authorization
string
header
required

Headers

X-Workspace-Id
string<uuid>
required

UUID of the workspace to act in. Take it from GET /me (workspaces[].id). A key scoped to specific workspaces is rejected with 403 WORKSPACE_NOT_ALLOWED for any other id; a missing header is 400 WORKSPACE_REQUIRED.

Body

application/json
keywordPlacements
string[]
Maximum array length: 50
Required string length: 1 - 100
titlePattern
enum<string>
Available options:
keyword-brand,
keyword-subtitle,
brand-keyword,
custom
customTitleTemplate
string
Maximum string length: 150
descriptionPattern
enum<string>
Available options:
benefit,
feature,
question,
custom
customDescriptionTemplate
string
Maximum string length: 150
excerptPattern
enum<string>
Available options:
summary,
hook,
key-points,
custom
customExcerptTemplate
string
Maximum string length: 150
targetRegions
string[]
Maximum array length: 50
Required string length: 1 - 100
regionalAdaptations
object
Maximum array length: 100
Required string length: 1 - 300

Response

The SEO rules after the change

data
object
required