Change a site name

PATCH

/sites/{site_id}

curl --request PATCH \
  --url https://api.wpengineapi.com/v1/sites/example \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "My New Name" }'

Authorizations

• basicAuth

Parameters

Path Parameters

site_id

required

string format: uuid

The ID of the site to change the name of (For accounts with sites enabled)

Request Body

Properties

• name - The new name for the site

Media type application/json

object

name

The new site name

string

Example

My New Name

Responses

200

Updated

Media type application/json

object

id

required

string format: uuid

name

required

string

account

required

object

id

The account ID

string format: uuid

group_name

string

tags

Array<string>

created_at

The date and time the site was created in UTC

string format: date-time

sandbox

Whether the site is a sandbox site

boolean

transferable

Whether the site is transferable

boolean

installs

Array

object

id

string format: uuid

name

string

environment

string

Allowed values: production staging development

cname

Returns the CNAME of the install

string

php_version

The PHP version used to run WordPress

string

is_multisite

boolean

Example

{
  "id": "28c78b6d-c2da-4f09-85f5-1ad588089b2d",
  "name": "Torque Magazine",
  "account": {
    "id": "eeda3227-9a39-46ae-9e14-20958bb4e6c9"
  },
  "group_name": "Overdue",
  "tags": [
    "tag1",
    "tag2",
    "tag3"
  ],
  "created_at": "2025-07-10T09:59:58.684Z",
  "sandbox": false,
  "transferable": false,
  "installs": [
    {
      "id": "294deacc-d8b8-4005-82c4-0727ba8ddde0",
      "name": "torquemag",
      "environment": "production",
      "cname": "mywebsite.wpengine.com",
      "php_version": "7.3",
      "is_multisite": false
    }
  ]
}

400

Bad Request

Media type application/json

object

message

required

A message regarding the error that occurred on the server

string

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

errors

An array of error objects describing specific errors that arose when servicing the request

Array<object>

object

resource

required

The name of the resource that was being processed when the error occurred

string

field

required

(Optional) The specific field associated with the error

string

type

required

(Optional) A type associated with the error. invalid_value, access_error, value_unavailable

string

code

required

(Optional) A machine code relating to the error that occurred with the field and resource

string

message

required

(Optional) A human-readable message relating to the error that occurred with the field and resource

string

Example

{
  "message": "Invalid Site: Name cannot be empty.",
  "errors": [
    {
      "resource": "Site",
      "field": "name",
      "type": "invalid_value",
      "code": "too_long",
      "message": "Name is too long (maximum is 40 characters)"
    }
  ]
}

401

Authentication Error

Media type application/json

object

message

required

A message regarding the error that occurred on the server

string

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

Example

{
  "message": "Bad Credentials"
}

403

Not authorized

Media type application/json

object

message

required

A message regarding the error that occurred on the server

string

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

Example

{
  "message": "You don't have permission to perform that action"
}

404

Not found

Media type application/json

object

message

required

A message regarding the error that occurred on the server

string

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

Example

{
  "message": "Not Found"
}

429

Too many requests

Media type application/json

503

Service unavailable

Media type application/json