Skip to main content
PUT
/
v2
/
follow_ups
/
{id}
Update
curl --request PUT \
  --url https://api.incident.io/v2/follow_ups/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assignee_id": "01FCNDV6P870EA6S7TK1DSYDG0",
  "assignee_team_id": "01FCNDV6P870EA6S7TK1DSYDG0",
  "description": "Call the fire brigade",
  "follow_up_category_id": "01GNW4BAQ7XRMFF6FHKNXDFPRW",
  "follow_up_priority_option_id": "01GNW4BAQ7XRMFF6FHKNXDFPRW",
  "labels": [
    "bug",
    "urgent"
  ],
  "status": "outstanding",
  "title": "Add alerting on replica lag"
}
'
{
  "follow_up": {
    "assignee": {
      "email": "lisa@incident.io",
      "id": "01FCNDV6P870EA6S7TK1DSYDG0",
      "name": "Lisa Karlin Curtis",
      "role": "owner",
      "slack_user_id": "U02AYNF2XJM"
    },
    "assignee_team": {
      "id": "abc123",
      "name": "abc123"
    },
    "completed_at": "2021-08-17T13:28:57.801578Z",
    "created_at": "2021-08-17T13:28:57.801578Z",
    "creator": {
      "alert": {
        "id": "01GW2G3V0S59R238FAHPDS1R66",
        "title": "*errors.withMessage: PG::Error failed to connect"
      },
      "api_key": {
        "id": "01FCNDV6P870EA6S7TK1DSYDG0",
        "name": "My test API key"
      },
      "user": {
        "email": "lisa@incident.io",
        "id": "01FCNDV6P870EA6S7TK1DSYDG0",
        "name": "Lisa Karlin Curtis",
        "role": "owner",
        "slack_user_id": "U02AYNF2XJM"
      },
      "workflow": {
        "id": "01FCNDV6P870EA6S7TK1DSYDG0",
        "name": "My little workflow"
      }
    },
    "description": "Call the fire brigade",
    "external_issue_reference": {
      "issue_name": "INC-123",
      "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up",
      "provider": "asana"
    },
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "labels": [
      "bug",
      "urgent"
    ],
    "priority": {
      "description": "A follow-up that requires immediate attention.",
      "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW",
      "name": "Urgent",
      "rank": 10
    },
    "status": "outstanding",
    "title": "Cat is stuck in the tree",
    "updated_at": "2021-08-17T13:28:57.801578Z"
  }
}

Authorizations

Authorization
string
header
required

API key from your incident.io dashboard (Settings → API keys)

Path Parameters

id
string
required

Unique identifier for the follow-up

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

Body

application/json
status
enum<string>
required

Status of the follow-up. Setting this to deleted is not allowed; use the delete endpoint instead.

Available options:
outstanding,
completed,
deleted,
not_doing
Example:

"outstanding"

title
string
required

Title of the follow-up

Example:

"Add alerting on replica lag"

assignee_id
string

ID of the user this follow-up is assigned to. Set to null to unassign.

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

assignee_team_id
string

ID of the team this follow-up is assigned to. Set to null to unassign.

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

description
string

Description of the follow-up. Supports Markdown.

Example:

"Call the fire brigade"

follow_up_category_id
string

ID of the category for this follow-up

Example:

"01GNW4BAQ7XRMFF6FHKNXDFPRW"

follow_up_priority_option_id
string

ID of the priority for this follow-up

Example:

"01GNW4BAQ7XRMFF6FHKNXDFPRW"

labels
string[]

Labels associated with this follow-up

Example:
["bug", "urgent"]

Response

200 - application/json

OK response.

follow_up
object
required