Edit a page
curl --request PATCH \
--url https://api.wondeya.com/v1/pages/{pageId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"path": "<string>",
"editorial": {
"badge": {
"es": "<string>",
"en": "<string>"
},
"title": {
"es": "<string>",
"en": "<string>"
},
"titleAccent": {
"es": "<string>",
"en": "<string>"
},
"description": {
"es": "<string>",
"en": "<string>"
}
},
"seo": {
"title": {
"es": "<string>",
"en": "<string>"
},
"description": {
"es": "<string>",
"en": "<string>"
}
},
"sitemap": {
"priority": {},
"sitemapExclude": true
},
"body": {
"es": "<string>",
"en": "<string>"
},
"agentId": "<string>"
}
'import requests
url = "https://api.wondeya.com/v1/pages/{pageId}"
payload = {
"name": "<string>",
"path": "<string>",
"editorial": {
"badge": {
"es": "<string>",
"en": "<string>"
},
"title": {
"es": "<string>",
"en": "<string>"
},
"titleAccent": {
"es": "<string>",
"en": "<string>"
},
"description": {
"es": "<string>",
"en": "<string>"
}
},
"seo": {
"title": {
"es": "<string>",
"en": "<string>"
},
"description": {
"es": "<string>",
"en": "<string>"
}
},
"sitemap": {
"priority": {},
"sitemapExclude": True
},
"body": {
"es": "<string>",
"en": "<string>"
},
"agentId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
path: '<string>',
editorial: {
badge: {es: '<string>', en: '<string>'},
title: {es: '<string>', en: '<string>'},
titleAccent: {es: '<string>', en: '<string>'},
description: {es: '<string>', en: '<string>'}
},
seo: {
title: {es: '<string>', en: '<string>'},
description: {es: '<string>', en: '<string>'}
},
sitemap: {priority: {}, sitemapExclude: true},
body: JSON.stringify({es: '<string>', en: '<string>'}),
agentId: '<string>'
})
};
fetch('https://api.wondeya.com/v1/pages/{pageId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.wondeya.com/v1/pages/{pageId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'path' => '<string>',
'editorial' => [
'badge' => [
'es' => '<string>',
'en' => '<string>'
],
'title' => [
'es' => '<string>',
'en' => '<string>'
],
'titleAccent' => [
'es' => '<string>',
'en' => '<string>'
],
'description' => [
'es' => '<string>',
'en' => '<string>'
]
],
'seo' => [
'title' => [
'es' => '<string>',
'en' => '<string>'
],
'description' => [
'es' => '<string>',
'en' => '<string>'
]
],
'sitemap' => [
'priority' => [
],
'sitemapExclude' => true
],
'body' => [
'es' => '<string>',
'en' => '<string>'
],
'agentId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.wondeya.com/v1/pages/{pageId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"path\": \"<string>\",\n \"editorial\": {\n \"badge\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"title\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"titleAccent\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"description\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n }\n },\n \"seo\": {\n \"title\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"description\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n }\n },\n \"sitemap\": {\n \"priority\": {},\n \"sitemapExclude\": true\n },\n \"body\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"agentId\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.wondeya.com/v1/pages/{pageId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"path\": \"<string>\",\n \"editorial\": {\n \"badge\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"title\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"titleAccent\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"description\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n }\n },\n \"seo\": {\n \"title\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"description\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n }\n },\n \"sitemap\": {\n \"priority\": {},\n \"sitemapExclude\": true\n },\n \"body\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"agentId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wondeya.com/v1/pages/{pageId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"path\": \"<string>\",\n \"editorial\": {\n \"badge\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"title\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"titleAccent\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"description\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n }\n },\n \"seo\": {\n \"title\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"description\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n }\n },\n \"sitemap\": {\n \"priority\": {},\n \"sitemapExclude\": true\n },\n \"body\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"agentId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"kind": "agent",
"path": "<string>",
"status": "<string>",
"defaultLocale": "es",
"editorial": {
"badge": {
"es": "<string>",
"en": "<string>"
},
"title": {
"es": "<string>",
"en": "<string>"
},
"titleAccent": {
"es": "<string>",
"en": "<string>"
},
"description": {
"es": "<string>",
"en": "<string>"
}
},
"seo": {
"title": {
"es": "<string>",
"en": "<string>"
},
"description": {
"es": "<string>",
"en": "<string>"
}
},
"sitemap": {
"priority": 0.5,
"changefreq": "always",
"sitemapExclude": true
},
"body": {
"es": "<string>",
"en": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"agentId": "<string>",
"projectId": "<string>",
"publishedAt": "2023-11-07T05:31:56Z"
}Pages
Edit a page
Name, address, agent, editorial (agent page) or body (document page), and SEO metadata. Every field is optional; an absent field is left alone. Publishing is its own act.
PATCH
/
v1
/
pages
/
{pageId}
Edit a page
curl --request PATCH \
--url https://api.wondeya.com/v1/pages/{pageId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"path": "<string>",
"editorial": {
"badge": {
"es": "<string>",
"en": "<string>"
},
"title": {
"es": "<string>",
"en": "<string>"
},
"titleAccent": {
"es": "<string>",
"en": "<string>"
},
"description": {
"es": "<string>",
"en": "<string>"
}
},
"seo": {
"title": {
"es": "<string>",
"en": "<string>"
},
"description": {
"es": "<string>",
"en": "<string>"
}
},
"sitemap": {
"priority": {},
"sitemapExclude": true
},
"body": {
"es": "<string>",
"en": "<string>"
},
"agentId": "<string>"
}
'import requests
url = "https://api.wondeya.com/v1/pages/{pageId}"
payload = {
"name": "<string>",
"path": "<string>",
"editorial": {
"badge": {
"es": "<string>",
"en": "<string>"
},
"title": {
"es": "<string>",
"en": "<string>"
},
"titleAccent": {
"es": "<string>",
"en": "<string>"
},
"description": {
"es": "<string>",
"en": "<string>"
}
},
"seo": {
"title": {
"es": "<string>",
"en": "<string>"
},
"description": {
"es": "<string>",
"en": "<string>"
}
},
"sitemap": {
"priority": {},
"sitemapExclude": True
},
"body": {
"es": "<string>",
"en": "<string>"
},
"agentId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
path: '<string>',
editorial: {
badge: {es: '<string>', en: '<string>'},
title: {es: '<string>', en: '<string>'},
titleAccent: {es: '<string>', en: '<string>'},
description: {es: '<string>', en: '<string>'}
},
seo: {
title: {es: '<string>', en: '<string>'},
description: {es: '<string>', en: '<string>'}
},
sitemap: {priority: {}, sitemapExclude: true},
body: JSON.stringify({es: '<string>', en: '<string>'}),
agentId: '<string>'
})
};
fetch('https://api.wondeya.com/v1/pages/{pageId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.wondeya.com/v1/pages/{pageId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'path' => '<string>',
'editorial' => [
'badge' => [
'es' => '<string>',
'en' => '<string>'
],
'title' => [
'es' => '<string>',
'en' => '<string>'
],
'titleAccent' => [
'es' => '<string>',
'en' => '<string>'
],
'description' => [
'es' => '<string>',
'en' => '<string>'
]
],
'seo' => [
'title' => [
'es' => '<string>',
'en' => '<string>'
],
'description' => [
'es' => '<string>',
'en' => '<string>'
]
],
'sitemap' => [
'priority' => [
],
'sitemapExclude' => true
],
'body' => [
'es' => '<string>',
'en' => '<string>'
],
'agentId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.wondeya.com/v1/pages/{pageId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"path\": \"<string>\",\n \"editorial\": {\n \"badge\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"title\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"titleAccent\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"description\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n }\n },\n \"seo\": {\n \"title\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"description\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n }\n },\n \"sitemap\": {\n \"priority\": {},\n \"sitemapExclude\": true\n },\n \"body\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"agentId\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.wondeya.com/v1/pages/{pageId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"path\": \"<string>\",\n \"editorial\": {\n \"badge\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"title\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"titleAccent\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"description\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n }\n },\n \"seo\": {\n \"title\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"description\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n }\n },\n \"sitemap\": {\n \"priority\": {},\n \"sitemapExclude\": true\n },\n \"body\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"agentId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wondeya.com/v1/pages/{pageId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"path\": \"<string>\",\n \"editorial\": {\n \"badge\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"title\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"titleAccent\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"description\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n }\n },\n \"seo\": {\n \"title\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"description\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n }\n },\n \"sitemap\": {\n \"priority\": {},\n \"sitemapExclude\": true\n },\n \"body\": {\n \"es\": \"<string>\",\n \"en\": \"<string>\"\n },\n \"agentId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"kind": "agent",
"path": "<string>",
"status": "<string>",
"defaultLocale": "es",
"editorial": {
"badge": {
"es": "<string>",
"en": "<string>"
},
"title": {
"es": "<string>",
"en": "<string>"
},
"titleAccent": {
"es": "<string>",
"en": "<string>"
},
"description": {
"es": "<string>",
"en": "<string>"
}
},
"seo": {
"title": {
"es": "<string>",
"en": "<string>"
},
"description": {
"es": "<string>",
"en": "<string>"
}
},
"sitemap": {
"priority": 0.5,
"changefreq": "always",
"sitemapExclude": true
},
"body": {
"es": "<string>",
"en": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"agentId": "<string>",
"projectId": "<string>",
"publishedAt": "2023-11-07T05:31:56Z"
}Authorizations
A workspace API key: wdy_live_… / wdy_test_…. Created at POST /workspaces/{tenantId}/keys and shown exactly once.
Path Parameters
Body
application/json
Required string length:
1 - 80The address under the workspace host. / is the home page, and exactly one page per workspace has it. Otherwise up to 4 segments of letters, digits and single hyphens (/pymes, /enterprise/latam). Case-insensitive and stored lowercase. Never percent-encoded, never a dot segment. Reserved by the platform (and their whole subtree): admin, api, app, cdn, console, docs, embed, mail, status, storage, well-known, widget, www.
Maximum string length:
200Show child attributes
Show child attributes
The page's SEO metadata (D-48): <title> and meta description, per language. Valid on both kinds; an empty field inherits the site's home page.
Show child attributes
Show child attributes
The page's sitemap hints (D-49.d): priority/changefreq/exclude.
Show child attributes
Show child attributes
The markdown of a document page (D-47), per language. Only valid on a document page; an absent language is left alone, "" takes it off, and the source language may not be emptied.
Show child attributes
Show child attributes
Repoint the page at another agent of the same workspace. Everything the page says changes with it.
Re-sources the page: the language the owner writes in. Must be one the SITE serves; the set itself is the project’s (D-44).
Available options:
es, en Response
agent or document (D-47).
Available options:
agent, document The address under the site host. / is home.
draft or published.
Available options:
es, en The owner-written framing (agent page). Empty for a document.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The markdown of a document page. Empty for an agent page.
Show child attributes
Show child attributes
The brain that answers here. Absent for a document page.
The site (project) the page lives in.