Edit Event

This endpoint serves the purpose of modifying an event based on unique event ID.

PATCH /events/{id}

Edit Event

cURL

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",
  "venue": {
    "venue_id": "<string>",
    "name": "<string>",
    "address": "<string>",
    "city": "<string>",
    "zip": "<string>",
    "saved": "<string>"
  },
  "event_id": "<string>",
  "job_id": "<string>",
  "client_id": "<string>",
  "admin_comments": "<string>",
  "comments": "<string>",
  "custom_fields_text": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "custom_fields_id": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}
'

200

{
  "id": 123,
  "name": "<string>",
  "date": "2023-12-25",
  "event_id": "<string>",
  "client_id": "<string>",
  "created": "2023-12-25",
  "location": {
    "id": 123,
    "name": "<string>",
    "address": "<string>",
    "city": "<string>",
    "zip": "<string>",
    "saved": true
  },
  "admin_origin": {
    "personnel_id": 123,
    "name": "<string>"
  },
  "reviewer": {
    "personnel_id": 123,
    "name": "<string>"
  },
  "time_tracking_manager": {
    "personnel_id": 123,
    "name": "<string>"
  },
  "custom_fields": [
    {
      "id": "<string>",
      "name": "<string>",
      "value": "<string>"
    }
  ]
}

Authorizations

X-API-KEY · string · header · required

Path Parameters

id · string · required

Event ID

Body

application/json

name · string · required

date · string<date> · required

venue · object · required

Show child attributes

event_id · string

Pattern: ^[A-Za-z0-9]+

job_id · string

Maximum string length: 150

client_id · string

Pattern: ^[A-Za-z0-9]+

admin_comments · string

Maximum string length: 65535

comments · string

Maximum string length: 65535

custom_fields_text · object[]

Show child attributes

custom_fields_id · object[]

Show child attributes

Response

200

application/json

OK

id · number

name · string

date · string<date>

event_id · string

client_id · string

created · string<date>

location · Location · object

Show child attributes

admin_origin · EventPersonnel · object

Show child attributes

reviewer · EventPersonnel · object

Show child attributes

time_tracking_manager · EventPersonnel · object

Show child attributes

custom_fields · CustomField · object[]

Show child attributes