Choose the property

POST

/v1/sites/{id}/gsc/property

curl --request POST \
  --url https://api.overwatch.weareheavy.dev/v1/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/gsc/property \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "property": "example" }'

• Production

Validated against a fresh list from the connected account - a property the account can’t read is refused. Arms the first sync. Owner/admin only.

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

The site’s UUID.

Request Body^required

Media typeapplication/json

object

property

required

string

Example^generated

{
  "property": "example"
}

Responses

200

The updated connection status.

Media typeapplication/json

A site’s Search Console connection, projected for display. The OAuth refresh token is sealed at rest and never appears in any response.

object

configured

required

Whether the server has a Google OAuth client configured.

boolean

status

required

string | null

Allowed values: pending-property connected error revoked

googleEmail

required

string | null

property

required

string | null

analyticsSyncedAt

required

Epoch ms of the last analytics sweep, or null.

integer | null

error

required

string | null

Example

{
  "status": "pending-property"
}

400

Missing property, or one the account doesn’t hold.

Media typeapplication/json

object

error

required

A human-readable error message.

string

Example^generated

{
  "error": "example"
}

401

Missing or invalid credentials.

Media typeapplication/json

object

error

required

A human-readable error message.

string

Example

{
  "error": "invalid api key"
}

404

Site not found, SEO app off, or not connected.

Media typeapplication/json

object

error

required

A human-readable error message.

string

Example^generated

{
  "error": "example"
}