sites

Eine Website umbenennen

Ändert den in Atelier201 angezeigten Namen. Auf den Namen folgt eine zufällige erste Adresse, die nie veröffentlicht wird. Andere Adressen bleiben unverändert (siehe setSiteAddress).

PATCH/v1/sites/{site_id}

Request

curl --request PATCH \
  --url 'https://api.atelier201.com/v1/sites/<site_id>' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>"
}'

import json
import requests

url = "https://api.atelier201.com/v1/sites/<site_id>"
headers = {
  "Authorization": "<api-key>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"name\":\"<string>\"}")

response = requests.request("PATCH", url, headers=headers, json=payload)
print(response.json())

const response = await fetch("https://api.atelier201.com/v1/sites/<site_id>", {
  method: "PATCH",
  headers: {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "name": "<string>"
  }),
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.atelier201.com/v1/sites/<site_id>");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"name\":\"<string>\"}");
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("PATCH", "https://api.atelier201.com/v1/sites/<site_id>", bytes.NewBuffer([]byte("{\"name\":\"<string>\"}")))
  req.Header.Set("Authorization", "<api-key>")
  req.Header.Set("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://api.atelier201.com/v1/sites/<site_id>"))
    .header("Authorization", "<api-key>")
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"name\":\"<string>\"}"))
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://api.atelier201.com/v1/sites/<site_id>")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "<api-key>"
request["Content-Type"] = "application/json"
request.body = "{\"name\":\"<string>\"}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "status": "creating",
    "plan": "free",
    "url": "<string>",
    "platform_url": "<string>",
    "guest": true,
    "draft": {
      "revision": "<string>",
      "updated_at": "<string>"
    },
    "published": {
      "build_id": "<string>",
      "generation": 123,
      "published_at": "<string>"
    },
    "generation": 123,
    "cover_at": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

Erfordert sites:write. Für Besucher ändert sich nichts.

Autorisierung

Authorizationbearerin headerrequired

Pfadparameter

site_idstringrequired

ID der Website oder ihr Slug (die Adresse vor .atelier201.page).

Body

application/jsonrequired

namestringrequiredlength: 1–80 chars

Antwort

application/json

Website umbenennen

dataobjectrequired

Show child attributes

data.idstringrequired

data.namestringrequired

data.slugstringrequired

data.statusenum<string>requiredone of: creating, ready, suspended, deleting

data.planenum<string>requiredone of: free, site

data.urlstringrequired

Hier finden Besucher die Website: unter ihrer primären benutzerdefinierten Domain oder ihrer atelier201.page-Adresse.

data.platform_urlstringrequired

data.guestbooleanrequired

Vor der Anmeldung von einem Agenten erstellt und noch nicht beansprucht: Die Website kann in der Vorschau angezeigt, aber nicht veröffentlicht werden.

data.draftobjectrequired

Show child attributes

data.draft.revisionstring | nullrequired

data.draft.updated_atstring | nullrequired

data.publishedobject | nullrequired

Show child attributes

data.published.build_idstringrequired

data.published.generationintegerrequiredrange: -9007199254740991–9007199254740991

data.published.published_atstring | nullrequired

data.generationintegerrequiredrange: -9007199254740991–9007199254740991

Wird bei jeder Veröffentlichung, jedem Rollback und jeder Rücknahme einer Veröffentlichung erhöht. Sende den Wert als expected_generation zurück.

data.cover_atstring | nullrequired

Zeitpunkt, zu dem zuletzt nach einem Build der Website das Bild der Startseite aufgenommen wurde, das die App auf der Website-Karte anzeigt. Vor dem ersten Build null.

data.created_atstringrequired

ISO 8601, UTC.

data.updated_atstringrequired

ISO 8601, UTC.

request_idstringrequired

curl --request PATCH \ --url 'https://api.atelier201.com/v1/sites/<site_id>' \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "name": "<string>" }'

{ "data": { "id": "<string>", "name": "<string>", "slug": "<string>", "status": "creating", "plan": "free", "url": "<string>", "platform_url": "<string>", "guest": true, "draft": { "revision": "<string>", "updated_at": "<string>" }, "published": { "build_id": "<string>", "generation": 123, "published_at": "<string>" }, "generation": 123, "cover_at": "<string>", "created_at": "<string>", "updated_at": "<string>" }, "request_id": "<string>" }

{ "error": { "type": "<string>", "code": "<string>", "message": "<string>", "param": "<string>", "docs_url": "<string>", "action_url": "<string>", "details": {} }, "request_id": "<string>" }

Eine Website umbenennen

Autorisierung

Pfadparameter

Body

Antwort

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies