Map Search Console property

PUT

/api/sites/{id}/integrations/google-search-console/property

curl --request PUT \
  --url https://hitkeep.com/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/integrations/google-search-console/property \
  --header 'Content-Type: application/json' \
  --cookie hk_token=<hk_token> \
  --data '{ "property_uri": "example" }'

Maps a visible Search Console property to a HitKeep site.

Authorizations

• cookieAuth

Parameters

Path Parameters

id

required

string format: uuid

Request Body ^required

Media type application/json

object

property_uri

required

string

Example ^generated

{
  "property_uri": "example"
}

Responses

200

Google Search Console site mapping

Media type application/json

object

can_manage

required

boolean

mapped

required

boolean

mapped_at

string format: date-time

property_permission_level

string

property_uri

string

site_id

required

string format: uuid

sync_status

object

imported_end_date

string format: date

imported_start_date

string format: date

last_attempt_at

string format: date-time

last_error_category

string

last_success_at

string format: date-time

manual

required

boolean

next_retry_at

string format: date-time

state

required

string

Allowed values: pending running succeeded failed needs_attention

team_id

required

string format: uuid

Example

{
  "sync_status": {
    "state": "pending"
  }
}

400

Invalid or unavailable property

Media type application/json

object

message

string

Example ^generated

{
  "message": "example"
}

403

Access denied

Media type application/json

object

message

string

Example ^generated

{
  "message": "example"
}

412

Google Search Console is not connected

Media type application/json

object

message

string

Example ^generated

{
  "message": "example"
}