Works

Update Work

Updates a work item's information.

POST
/works.update
AuthorizationBearer <token>

All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request. How do I find my token?

In: header

Empty Object

developed_with?works-update-request-issue-developed-with
priority?issue-priority

Priority of the work based upon impact and criticality.

Value in"p0" | "p1" | "p2" | "p3"
priority_v2?integer

Priority enum id of the work based upon impact and criticality. The allowed ids can be extended by the user. Stock allowed values:

  {
    "id": 1,
    "label": "P0",
    "ordinal": 1,
    "overridable": true
  },
  {
    "id": 2,
    "label": "P1",
    "ordinal": 2,
    "overridable": true
  },
  {
    "id": 3,
    "label": "P2",
    "ordinal": 3,
    "overridable": true
  },
  {
    "id": 4,
    "label": "P3",
    "ordinal": 4,
    "overridable": true
  }
Formatint64
sprint?string | null

Updates the sprint that the issue belongs to.

Formatid
target_start_date?string | null

Updates the timestamp for when the work is expected to start.

Formatdate-time
account?string | null

Updates the account that the ticket is associated with.

Formatid
channels?works-update-request-ticket-channels
channels_v2?array<string>

Updates channel IDs of the ticket.

group?string | null

Updates the group that the ticket is associated with.

Formatid
is_archived?boolean

Whether the ticket is archived.

is_frozen?boolean

Whether the ticket is frozen.

is_spam?boolean

Updates whether the ticket is spam.

needs_response?boolean

Updates whether the ticket needs a response.

rev_org?string | null

Updates the Rev organization that the ticket is associated with.

Formatid
sentiment?integer

The enum ID for the sentiment of the ticket. The allowed ids can be extended by the user. Stock allowed values:

  {
    "id": 1,
    "label": "Delighted",
    "ordinal": 1,
    "overridable": true
  },
  {
    "id": 2,
    "label": "Happy",
    "ordinal": 2,
    "overridable": true
  },
  {
    "id": 3,
    "label": "Neutral",
    "ordinal": 3,
    "overridable": true
  },
  {
    "id": 4,
    "label": "Unhappy",
    "ordinal": 4,
    "overridable": true
  },
  {
    "id": 5,
    "label": "Frustrated",
    "ordinal": 5,
    "overridable": true
  }
Formatint64
sentiment_modified_date?string

Timestamp at which sentiment was last modified.

Formatdate-time
sentiment_summary?string

Summary justifying the current sentiment.

Formattext
severity?ticket-severity

Severity of the ticket.

Value in"blocker" | "high" | "low" | "medium"
source_channel_v2?string | null

Updates the source channel of the ticket.

Formatid

Response Body

curl -X POST "https://api.devrev.ai/works.update" \  -H "Content-Type: application/json" \  -d '{    "id": "ISS-12345"  }'
{
  "work": {
    "type": "issue",
    "created_by": {
      "type": "dev_user",
      "display_id": "string",
      "id": "string",
      "display_name": "string",
      "display_picture": {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      },
      "email": "string",
      "full_name": "string",
      "state": "active"
    },
    "created_date": "2023-01-01T12:00:00.000Z",
    "display_id": "string",
    "id": "string",
    "modified_by": {
      "type": "dev_user",
      "display_id": "string",
      "id": "string",
      "display_name": "string",
      "display_picture": {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      },
      "email": "string",
      "full_name": "string",
      "state": "active"
    },
    "modified_date": "2023-01-01T12:00:00.000Z",
    "applies_to_part": {
      "type": "capability",
      "display_id": "string",
      "id": "string",
      "name": "string",
      "owned_by": [
        {
          "type": "dev_user",
          "display_id": "string",
          "id": "string",
          "display_name": "string",
          "display_picture": {
            "display_id": "string",
            "id": "string",
            "file": {
              "type": "string",
              "name": "string",
              "size": 0
            }
          },
          "email": "string",
          "full_name": "string",
          "state": "active"
        }
      ]
    },
    "artifacts": [
      {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      }
    ],
    "body": "string",
    "owned_by": [
      {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      }
    ],
    "reported_by": [
      {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      }
    ],
    "stage": {
      "name": "string"
    },
    "tags": [
      {
        "tag": {
          "display_id": "string",
          "id": "string",
          "name": "string"
        },
        "value": "string"
      }
    ],
    "target_close_date": "2023-01-01T12:00:00.000Z",
    "title": "string",
    "developed_with": [
      {
        "type": "capability",
        "display_id": "string",
        "id": "string",
        "name": "string",
        "owned_by": [
          {
            "type": "dev_user",
            "display_id": "string",
            "id": "string",
            "display_name": "string",
            "display_picture": {
              "display_id": "string",
              "id": "string",
              "file": {
                "type": "string",
                "name": "string",
                "size": 0
              }
            },
            "email": "string",
            "full_name": "string",
            "state": "active"
          }
        ]
      }
    ],
    "estimated_effort": 0.1,
    "priority": "p0",
    "priority_v2": {
      "id": 0,
      "label": "string",
      "ordinal": 0,
      "value": null
    },
    "sla_summary": {
      "closest_to_breach_metric": "string",
      "org_schedule": {
        "display_id": "string",
        "id": "string",
        "name": "string",
        "status": "archived",
        "timezone": "string",
        "valid_until": "2023-01-01T12:00:00.000Z"
      },
      "remaining_time": 0,
      "sla_tracker": {
        "created_by": {
          "type": "dev_user",
          "display_id": "string",
          "id": "string",
          "display_name": "string",
          "display_picture": {
            "display_id": "string",
            "id": "string",
            "file": {
              "type": "string",
              "name": "string",
              "size": 0
            }
          },
          "email": "string",
          "full_name": "string",
          "state": "active"
        },
        "created_date": "2023-01-01T12:00:00.000Z",
        "display_id": "string",
        "id": "string",
        "modified_by": {
          "type": "dev_user",
          "display_id": "string",
          "id": "string",
          "display_name": "string",
          "display_picture": {
            "display_id": "string",
            "id": "string",
            "file": {
              "type": "string",
              "name": "string",
              "size": 0
            }
          },
          "email": "string",
          "full_name": "string",
          "state": "active"
        },
        "modified_date": "2023-01-01T12:00:00.000Z",
        "applies_to_id": "string",
        "applies_to_type": "conversation",
        "metric_target_summaries": [
          {
            "breached_at": "2023-01-01T12:00:00.000Z",
            "completed_at": "2023-01-01T12:00:00.000Z",
            "completed_in": 0,
            "in_policy": true,
            "is_out_of_schedule": true,
            "metric_definition": {
              "display_id": "string",
              "id": "string",
              "name": "string"
            },
            "next_schedule_transition": "2023-01-01T12:00:00.000Z",
            "org_schedule": {
              "display_id": "string",
              "id": "string",
              "name": "string",
              "status": "archived",
              "timezone": "string",
              "valid_until": "2023-01-01T12:00:00.000Z"
            },
            "remaining_time": 0,
            "stage": "string",
            "status": "string",
            "target_time": "2023-01-01T12:00:00.000Z",
            "warning_target_time": "2023-01-01T12:00:00.000Z"
          }
        ],
        "removed_sla_metric_history": [
          {}
        ],
        "sla": {
          "display_id": "string",
          "id": "string",
          "name": "string",
          "sla_type": "external",
          "status": "archived"
        },
        "sla_policy_id": "string",
        "stage": "string",
        "status": "string"
      },
      "stage": "breached",
      "target_time": "2023-01-01T12:00:00.000Z"
    },
    "sla_tracker": {
      "display_id": "string",
      "id": "string",
      "applies_to_type": "conversation"
    },
    "sprint": {
      "type": "curated",
      "end_date": "2023-01-01T12:00:00.000Z",
      "id": "string",
      "name": "string",
      "start_date": "2023-01-01T12:00:00.000Z",
      "state": "active"
    },
    "target_start_date": "2023-01-01T12:00:00.000Z"
  }
}
{
  "detail": "string",
  "message": "string",
  "type": "artifact_already_attached_to_a_parent",
  "existing_parent": "string",
  "is_same": true
}
{
  "detail": "string",
  "message": "string",
  "type": "unauthenticated"
}
{
  "detail": "string",
  "message": "string",
  "type": "forbidden"
}
{
  "detail": "string",
  "message": "string",
  "type": "not_found"
}
{
  "detail": "string",
  "message": "string",
  "type": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}