Skip to content
Website BuddyWebsite BuddyWebsite builder
Sign inGet started
API reference/Events

Change an event

Try it

Changes an event. Only the fields you send change. published=false takes it off the site at once.

PATCH/api/v1/sites/{site_id}/events/{event_id}

Authentication

An API key as Authorization: Bearer or x-api-key. It needs the events:write scope — add, change and delete events (live at once).

events:writeChanges the live siteIdempotency-Key optionalMCP tool: update_event

Parameters

Named placeholders go in the path; the rest in a JSON body.

site_idstringPath · required
The site's id.1 to 100 characters
event_idstringPath · required
The event's id.1 to 100 characters
titlestringBody · optional
The event's name.2 to 160 characters
slugstringBody · optional
The web address after /events/. Omitted = made from the title.At most 80 characters
summarystringBody · optional
One short line for lists and link previews.At most 300 characters
descriptionstringBody · optional
The details as plain text (blank line = new paragraph).At most 8000 characters
start_datestringBody · optional
The first (or only) day, YYYY-MM-DD, in the site's time zone.
start_timestring | nullBody · optional
HH:MM (24-hour); null = all day.
end_timestring | nullBody · optional
HH:MM, after start_time; null = no end time.
repeatstringBody · optional
none, weekly or monthly.One of: none, weekly, monthly
repeat_untilstring | nullBody · optional
Last day a repeating event happens; null = no end.
locationstringBody · optional
A room or place name.At most 160 characters
addressstringBody · optional
The address for the map; empty = the business's own.At most 200 characters
image_urlstring | nullBody · optional
A /media/… address from the picture library, or null.At most 500 characters
link_urlstring | nullBody · optional
An outside link (sign-up, tickets): https://… or a /path on the site.At most 500 characters
link_labelstring | nullBody · optional
The link's button words.At most 40 characters
publishedbooleanBody · optional
true = on the site at once; false = hidden.

Response

200 with JSON on success (schema on the right). Errors use the standard envelope; a retry with the same Idempotency-Key gets the first answer back (how retries work).

curl
curl -X PATCH 'https://websites.workflowcorp.com/api/v1/sites/SITE_ID/events/EVENT_ID' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Example arguments
{
  "site_id": "SITE_ID",
  "event_id": "EVENT_ID"
}
Response schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "summary": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "start_date": {
      "type": "string",
      "description": "YYYY-MM-DD, the first (or only) day, in the site's time zone."
    },
    "start_time": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "HH:MM (24-hour) in the site's time zone; null = all day."
    },
    "end_time": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "repeat": {
      "type": "string",
      "enum": [
        "none",
        "weekly",
        "monthly"
      ],
      "description": "none, weekly (same weekday) or monthly (same week of the month, e.g. the first Sunday)."
    },
    "repeat_until": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "rhythm": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "The repeat in words: \"Every Wednesday\"."
    },
    "next_date": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "The next day it happens that isn't over yet; null = over."
    },
    "location": {
      "type": "string"
    },
    "address": {
      "type": "string",
      "description": "The address on the map; empty = the business's own."
    },
    "image_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "link_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "link_label": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "published": {
      "type": "boolean",
      "description": "Shown on the site."
    },
    "url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "The event's page on the live site — null while hidden."
    },
    "is_sample": {
      "type": "boolean"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "title",
    "slug",
    "summary",
    "description",
    "start_date",
    "start_time",
    "end_time",
    "repeat",
    "repeat_until",
    "rhythm",
    "next_date",
    "location",
    "address",
    "image_url",
    "link_url",
    "link_label",
    "published",
    "url",
    "is_sample",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false
}