sites

Update Goal

Update a goal's fields or status.

patch/sites/{site_id}/goals/{goal_id}

Request

  • Base URL: https://api.xeorank.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.xeorank.com/sites/{site_id}/goals/{goal_id}
  • Auth: API key in header X-Agent-Key

Path parameters

site_idstring required
goal_idstring required

Query parameters

emailstring nullable

Request body

titlestring nullable
descriptionstring nullable
categorystring nullable
stagestring nullable
statusstring nullable
prioritystring nullable
tagsstring[] nullable
metric_keystring nullable
target_valuenumber nullable
manual_doneinteger nullable
manual_totalinteger nullable
starts_atstring date-time nullable
due_atstring date-time nullable
owner_emailstring nullable

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.