Edit Event

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>"
    }
  ],
  "areas": [
    "<string>"
  ]
}
'

import requests

url = "https://api.roostedhr.com/api/1_12/events/{id}"

payload = {
    "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>"
        }
    ],
    "areas": ["<string>"]
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>'}],
    areas: ['<string>']
  })
};

fetch('https://api.roostedhr.com/api/1_12/events/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.roostedhr.com/api/1_12/events/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
        ]
    ],
    'areas' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.roostedhr.com/api/1_12/events/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"location\": {\n    \"location_id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"address\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zip\": \"<string>\",\n    \"saved\": \"<string>\"\n  },\n  \"event_id\": \"<string>\",\n  \"client_id\": \"<string>\",\n  \"admin_comments\": \"<string>\",\n  \"comments\": \"<string>\",\n  \"custom_fields\": [\n    {\n      \"id\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"areas\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.roostedhr.com/api/1_12/events/{id}")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"location\": {\n    \"location_id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"address\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zip\": \"<string>\",\n    \"saved\": \"<string>\"\n  },\n  \"event_id\": \"<string>\",\n  \"client_id\": \"<string>\",\n  \"admin_comments\": \"<string>\",\n  \"comments\": \"<string>\",\n  \"custom_fields\": [\n    {\n      \"id\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"areas\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.roostedhr.com/api/1_12/events/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"location\": {\n    \"location_id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"address\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zip\": \"<string>\",\n    \"saved\": \"<string>\"\n  },\n  \"event_id\": \"<string>\",\n  \"client_id\": \"<string>\",\n  \"admin_comments\": \"<string>\",\n  \"comments\": \"<string>\",\n  \"custom_fields\": [\n    {\n      \"id\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"areas\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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>"
        }
      ]
    }
  ],
  "areas": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ]
}

Even though this is a PATCH endpoint, name, date, and location are required in every request. Omitting them returns a validation error.

Areas

Use the areas field to control area assignments. Omit it to leave the event’s areas unchanged. Send an empty array ([]) to clear all areas. Send a non-empty array of area IDs to replace the current set. Invalid IDs return a 400 error.

Authorizations

X-API-KEY

string

header

required

Path Parameters

string

required

Event ID

Body

application/json

name

string

required

date

string<date>

required

location

object

required

Show child attributes

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[]

Show child attributes

areas

string[]

Area IDs. Omit to leave unchanged; send [] to clear all; send a non-empty list to replace. Invalid IDs return 400.

Response

integer

name

string

date

string<date>

event_id

string

client_id

string

created

string<date>

location

Location · object

Show child attributes

admin_origin

EventManager · object

Show child attributes

reviewer

EventManager · object

Show child attributes

time_tracking_manager

EventManager · object

Show child attributes

custom_fields

CustomField · object[]

Show child attributes

areas

object[] | null

Areas/zones assigned to the event. Null if none.

Show child attributes

Get Event AdminsReturns the list of admins assigned to an event.

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>"
    }
  ],
  "areas": [
    "<string>"
  ]
}
'

import requests

url = "https://api.roostedhr.com/api/1_12/events/{id}"

payload = {
    "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>"
        }
    ],
    "areas": ["<string>"]
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>'}],
    areas: ['<string>']
  })
};

fetch('https://api.roostedhr.com/api/1_12/events/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.roostedhr.com/api/1_12/events/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
        ]
    ],
    'areas' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.roostedhr.com/api/1_12/events/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"location\": {\n    \"location_id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"address\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zip\": \"<string>\",\n    \"saved\": \"<string>\"\n  },\n  \"event_id\": \"<string>\",\n  \"client_id\": \"<string>\",\n  \"admin_comments\": \"<string>\",\n  \"comments\": \"<string>\",\n  \"custom_fields\": [\n    {\n      \"id\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"areas\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.roostedhr.com/api/1_12/events/{id}")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"location\": {\n    \"location_id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"address\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zip\": \"<string>\",\n    \"saved\": \"<string>\"\n  },\n  \"event_id\": \"<string>\",\n  \"client_id\": \"<string>\",\n  \"admin_comments\": \"<string>\",\n  \"comments\": \"<string>\",\n  \"custom_fields\": [\n    {\n      \"id\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"areas\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.roostedhr.com/api/1_12/events/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"location\": {\n    \"location_id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"address\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zip\": \"<string>\",\n    \"saved\": \"<string>\"\n  },\n  \"event_id\": \"<string>\",\n  \"client_id\": \"<string>\",\n  \"admin_comments\": \"<string>\",\n  \"comments\": \"<string>\",\n  \"custom_fields\": [\n    {\n      \"id\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"areas\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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>"
        }
      ]
    }
  ],
  "areas": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ]
}

Overview

Announcements

Areas

Clients

Company

Configuration

Events

Locations

Payroll Groups

Rate Cards

Skillsets

Time Tracking

Wage Rules

Workers

Areas

Authorizations

Path Parameters

Body

Response

​Areas

Authorizations

Path Parameters

Body

Response

Areas