Connect the YouTube channel
Connects the siteโs public YouTube channel from its URL, like the Sorank
settings page. The channel is resolved by a synchronous YouTube call
before the command is recorded: a malformed URL is invalid_url, a
channel YouTube does not expose or cannot find is
youtube_channel_unsupported or youtube_channel_not_found, an
exhausted YouTube quota is youtube_rate_limited (retryable, with
Retry-After when YouTube gives a delay) and a YouTube outage
youtube_unavailable. Another connected channel is replaced only with
replace: true (youtube_source_replacement_required otherwise); while a
previous channel is being removed the request is refused with
youtube_source_purge_in_progress (retryable, with Retry-After). The
catalog synchronization is queued, declared as youtube_sync_queued.
youtube_feature_disabled means the integration is disabled on this
deployment.
A valid request URL is required to generate request examples{
"data": {
"settings": {
"site": {
"website_url": "<string>",
"business_name": "<string>",
"brand_color": "<string>",
"market": {
"language": "<string>",
"country": "<string>",
"scope": "city",
"city": "<string>"
}
},
"business_brief": {
"status": "pending",
"revision": 1,
"document": {
"schema_version": 123,
"sections": [
{
"id": "identity",
"text": "<string>"
}
],
"offers": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>"
}
]
}
},
"competitors": {
"domains": [
"<string>"
],
"max_selections": 1
},
"articles": {
"calendar_exists": true,
"timezone": "<string>",
"local_time": "<string>",
"publish_as_draft": true,
"default_instructions": "<string>",
"expert_settings": {
"tone": "<string>",
"formality": "<string>",
"generate_images": true,
"image_source_mode": "ai_only",
"image_tone": "<string>",
"image_style": "<string>",
"ethnicity": "<string>",
"image_instructions": "<string>",
"conclusion_enabled": true,
"cta_enabled": true,
"cta_title": "<string>",
"include_homepage_screenshot": true,
"include_youtube_videos": true
}
},
"visuals": {
"image_mode": "ai_only",
"covers": {
"enabled": true,
"default_preset": {
"kind": "builtin",
"key": "sketch",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
},
"youtube": {
"connected": true,
"channel_title": "<string>",
"canonical_url": "<string>",
"enabled": true,
"sync_status": "syncing",
"last_synced_at": "2023-11-07T05:31:56Z",
"video_count": 1
}
},
"effects": [
"geo_questions_regeneration_queued"
],
"receipt": {
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "accepted",
"resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"meta": {
"request_id": "<string>",
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}Authorizations
Authorization-code grant with PKCE S256, exact scopes, explicit resource audience and a persisted consent grant. Obtain endpoint URLs from server discovery in the target environment. Refresh tokens remain client-bound.
- Authorization URL
- /oauth/authorize
- Token URL
- /oauth/token
- Refresh URL
- /oauth/token
Headers
Opaque client command key of 1 to 128 visible ASCII characters. UUID recommended; reuse only for the same command.
1 - 128^[!-~]+$Path Parameters
Profile UUID; must be in the grant allowlist and currently accessible to the actor.
Body
Public YouTube channel URL such as https://www.youtube.com/@name.
1 - 2048true replaces another connected channel.
A valid request URL is required to generate request examples{
"data": {
"settings": {
"site": {
"website_url": "<string>",
"business_name": "<string>",
"brand_color": "<string>",
"market": {
"language": "<string>",
"country": "<string>",
"scope": "city",
"city": "<string>"
}
},
"business_brief": {
"status": "pending",
"revision": 1,
"document": {
"schema_version": 123,
"sections": [
{
"id": "identity",
"text": "<string>"
}
],
"offers": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>"
}
]
}
},
"competitors": {
"domains": [
"<string>"
],
"max_selections": 1
},
"articles": {
"calendar_exists": true,
"timezone": "<string>",
"local_time": "<string>",
"publish_as_draft": true,
"default_instructions": "<string>",
"expert_settings": {
"tone": "<string>",
"formality": "<string>",
"generate_images": true,
"image_source_mode": "ai_only",
"image_tone": "<string>",
"image_style": "<string>",
"ethnicity": "<string>",
"image_instructions": "<string>",
"conclusion_enabled": true,
"cta_enabled": true,
"cta_title": "<string>",
"include_homepage_screenshot": true,
"include_youtube_videos": true
}
},
"visuals": {
"image_mode": "ai_only",
"covers": {
"enabled": true,
"default_preset": {
"kind": "builtin",
"key": "sketch",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
},
"youtube": {
"connected": true,
"channel_title": "<string>",
"canonical_url": "<string>",
"enabled": true,
"sync_status": "syncing",
"last_synced_at": "2023-11-07T05:31:56Z",
"video_count": 1
}
},
"effects": [
"geo_questions_regeneration_queued"
],
"receipt": {
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "accepted",
"resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"meta": {
"request_id": "<string>",
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}