Skip to main content
PATCH
/
events
/
{id}
Edit Event
curl --request PATCH \
  --url https://api.roostedhr.com/api/1_12/events/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "date": "2023-12-25",
  "location": {
    "location_id": "<string>",
    "name": "<string>",
    "address": "<string>",
    "city": "<string>",
    "zip": "<string>",
    "saved": "<string>"
  },
  "event_id": "<string>",
  "client_id": "<string>",
  "admin_comments": "<string>",
  "comments": "<string>",
  "custom_fields": [
    {
      "id": "<string>",
      "value": "<string>"
    }
  ]
}
'
{
  "id": 123,
  "name": "<string>",
  "date": "2023-12-25",
  "event_id": "<string>",
  "client_id": "<string>",
  "created": "2023-12-25",
  "location": {
    "id": "<string>",
    "location": "<string>",
    "addy_street_number": "<string>",
    "addy_city": "<string>",
    "addy_zip": "<string>",
    "location_comments": "<string>",
    "default": 0,
    "saved": 0,
    "color": "#DC136C",
    "timezone": {
      "id": 123,
      "name": "<string>",
      "offset": "<string>"
    },
    "companies_payroll_rulesets_id": "<string>",
    "payroll_rule_display": "<string>",
    "latitude": "<string>",
    "longitude": "<string>",
    "default_clients_id": "<string>",
    "default_areas": [
      "<string>"
    ]
  },
  "admin_origin": {
    "personnel_id": "<string>",
    "name": "<string>"
  },
  "reviewer": {
    "personnel_id": "<string>",
    "name": "<string>"
  },
  "time_tracking_manager": {
    "personnel_id": "<string>",
    "name": "<string>"
  },
  "custom_fields": [
    {
      "id": "<string>",
      "name": "<string>",
      "value": "<string>",
      "options": [
        {
          "title": "<string>",
          "value": "<string>"
        }
      ]
    }
  ]
}
Even though this is a PATCH endpoint, name, date, and location are required in every request. Omitting them returns a validation error.

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required

Event ID

Body

application/json
​
name
string
required
​
date
string<date>
required
​
location
object
required
​
event_id
string
Pattern: ^[A-Za-z0-9]+
​
client_id
string
Pattern: ^[A-Za-z0-9]+
​
admin_comments
string
Maximum string length: 65535
​
comments
string
Maximum string length: 65535
​
custom_fields
object[]

Response

OK

​
id
integer
​
name
string
​
date
string<date>
​
event_id
string
​
client_id
string
​
created
string<date>
​
location
Location · object
​
admin_origin
EventManager · object
​
reviewer
EventManager · object
​
time_tracking_manager
EventManager · object
​
custom_fields
CustomField · object[]