Skip to main content
PATCH
/
api
/
incidents
/
v1
/
{incident_id}
/
state
UpdateIncidentState
curl --request PATCH \
  --url https://developer.synq.io/api/incidents/v1/{incident_id}/state \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "actor": {
    "name": "<string>",
    "email": {
      "userEmail": "jsmith@example.com"
    }
  },
  "at": "2023-11-07T05:31:56Z"
}
'
import requests

url = "https://developer.synq.io/api/incidents/v1/{incident_id}/state"

payload = {
"actor": {
"name": "<string>",
"email": { "userEmail": "jsmith@example.com" }
},
"at": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
actor: {name: '<string>', email: {userEmail: 'jsmith@example.com'}},
at: '2023-11-07T05:31:56Z'
})
};

fetch('https://developer.synq.io/api/incidents/v1/{incident_id}/state', 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://developer.synq.io/api/incidents/v1/{incident_id}/state",
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([
'actor' => [
'name' => '<string>',
'email' => [
'userEmail' => 'jsmith@example.com'
]
],
'at' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$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://developer.synq.io/api/incidents/v1/{incident_id}/state"

payload := strings.NewReader("{\n \"actor\": {\n \"name\": \"<string>\",\n \"email\": {\n \"userEmail\": \"jsmith@example.com\"\n }\n },\n \"at\": \"2023-11-07T05:31:56Z\"\n}")

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

req.Header.Add("Authorization", "Bearer <token>")
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://developer.synq.io/api/incidents/v1/{incident_id}/state")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"actor\": {\n \"name\": \"<string>\",\n \"email\": {\n \"userEmail\": \"jsmith@example.com\"\n }\n },\n \"at\": \"2023-11-07T05:31:56Z\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://developer.synq.io/api/incidents/v1/{incident_id}/state")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"actor\": {\n \"name\": \"<string>\",\n \"email\": {\n \"userEmail\": \"jsmith@example.com\"\n }\n },\n \"at\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body
{
  "incident": {
    "id": "<string>",
    "index": 123,
    "name": "<string>",
    "issueIds": [
      "<string>"
    ],
    "createdBy": {
      "name": "<string>",
      "email": {
        "userEmail": "jsmith@example.com"
      }
    },
    "owner": {
      "id": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>",
      "identities": [
        "<string>"
      ]
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedBy": {
      "name": "<string>",
      "email": {
        "userEmail": "jsmith@example.com"
      }
    },
    "updatedAt": "2023-11-07T05:31:56Z",
    "comments": [
      {
        "id": "<string>",
        "message": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "actor": {
          "name": "<string>",
          "email": {
            "userEmail": "jsmith@example.com"
          }
        }
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

incident_id
string<uuid>
required

Body

application/json
actor
Actor · object
required

Actor updating the incident state

at
string<date-time>
required

Time at which the incident state was updated. Defaults to the current time. timestamp.gt = 2022-01-01T00:00:00Z timestamp.gt_lt = 2022-01-01T00:00:00Z timestamp.gt_lt_exclusive = 2022-01-01T00:00:00Z timestamp.gt_lte = 2022-01-01T00:00:00Z timestamp.gt_lte_exclusive = 2022-01-01T00:00:00Z timestamp.lt_now = true

Examples:

"2023-01-15T01:30:15.01Z"

"2024-12-25T12:00:00Z"

state
enum<string>
required

New state for the incident

Available options:
STATE_UNSPECIFIED,
STATE_OPEN,
STATE_CLOSED,
STATE_CANCELLED

Response

200 - application/json

Success

incident
Incident · object