v1

latestOpenAPI 3.1.02026-07-24474114.4 KB

Update an Override

Updates the values of an existing override

patch/overrides/{id}

Path parameters

idstring required

override id

Headers

content-typestring required

Request body

typestring required

Pre defined overrides styles: 'alert' , info' or the name of an App , Board, or Media to display on your override

namestring required

Name of the Override

messagestring json required

Takes the value to be used for displaying content on the override such as 'color', 'text' and 'icon'

colorstring

color of the message example "#Fc5543"

textstring

text to be displayed in message

iconstring

available list of icons, which should be named by a pattern "fas||exclamation-triangle"

day_recurrencestring

accepts "Weekdays", "Every Day", "Weekends", "First of the Month", "Specific Days".

daysstring[]

only specified if in day_reccurence parameter passed "specific days". Accepts "mon", "tue", "wed", "thu", "fri", "sat", "sun"

time_recurrencestring

accepts "Once per Day" , "Multiple Times per Day"

hourstring

periodstring

parameters count in minutes

period_startstring

accepts time in format "08:00:00"

period_endstring

accepts time in format "08:00:00"

durationstring

accepts duration in seconds

Response

201

account_idstring

created_atnumber

folder_idstring

idstring

messagestring

namestring

organization_idstring

typestring

updated_atnumber

Example response

{
  "account_id": "5dba92731b5d034f7d8dca3d",
  "created_at": 1639489127.742,
  "folder_id": "5dba92731b5d034fa9abda24",
  "id": "61b89e671b5d0302ed8ddd64",
  "message": "{\"text\":\"sada\",\"color\":\"#Fc5543\",\"icon\":\"fas|exclamation-triangle\"}",
  "name": "ScheduledOne121",
  "organization_id": "607e96e463f1ad45609214ec",
  "scheduling": {
    "day_recurrence": "Specific Days",
    "days": [
      "sun"
    ],
    "duration": 60,
    "end_at": 1582895868,
    "hour": "12:00:00",
    "paused": true,
    "period": 120,
    "period_end": "17:00:00",
    "period_start": "08:00:00",
    "scheduling": "Recurring",
    "start_at": 1582895268,
    "time_recurrence": "Once per Day"
  },
  "type": "info",
  "updated_at": 1639489268.769
}