Actions

Rewrite the fields a customer owns, on actions they wrote or ones Peec generated. An edit is stored beside the generated wording rather than in it, so a regeneration cannot discard it. Only a customer's own action can change shape: the type and group of a generated one say what Peec found, and an item trying to move them lands in rejected. A field the item leaves out keeps what it held; null clears the ones that can be cleared, and an item naming no field at all is rejected rather than recorded as an edit. Ids the project publishes no action under are returned in skipped — the batch never fails as a whole. A content optimisation is reachable only on a project with content optimisation enabled; elsewhere its id is returned in skipped. A product page action is reachable only on a project with product page actions enabled, the same way.

post/actions/update

Request

  • Base URL
    https://api.peec.ai/customer/v1
  • URL
    https://api.peec.ai/customer/v1/actions/update
  • Auth
    • API key in header X-API-Key
    • or API key in query parameter api_key
    • or HTTP bearer

Request body

project_idstring

Required if using a company api key

Example request

{
  "project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb",
  "actions": [
    {
      "action_id": "01a0422f-e0c4-7820-85a1-31515a321f15",
      "topic_id": "to_a1b2c3",
      "prompt_ids": [
        "pr_a1b2c3"
      ],
      "steps": [
        {
          "title": "Add a pricing comparison table",
          "section": "Before publishing"
        }
      ],
      "due_on": "2026-10-31"
    }
  ]
}

Response

Per-item results

Changes