Sign in

v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Sites

Update site properties.

Endpoint that can be used to change limited site properties, like label.

patch/v1/sites/{id}

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Request body

labelstring nullable

A label which can be used to identify the site separately from the site's domain

metadataSiteMetadata
site_type0 | 1 | 2

Type of site. 0 == WordPress, 1 == static site

Example request

{
  "label": "agencypartner1::site1::abcd",
  "metadata": {
    "key": "value"
  }
}

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": []
}