Add issue watchers

POST 
https://your-domain/openapi/v2/project/issues/:issueID/watchers

Add issue watchers.

History

Version	Changes
v3.14.117, v3.15.26	Added in: v3.14.117, v3.15.26

Request

Path Parameters

issueID stringrequired

The ID of the issue

Query Parameters

teamID stringrequired

The team ID

application/json

Body

required

The users where need to add issue watchers

watchers string[]

Possible values: non-empty and <= 8 characters

issue watchers

Responses

200

Request successful.

application/json

Schema

Schema

result stringrequired

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

errorData object

Error meta data for this request.

Example (from schema)

[
  {
    "result": "SUCCESS"
  },
  {
    "result": "FAIL",
    "errorCode": "NotFound",
    "errorMsg": "NotFound issue"
  },
  {
    "result": "FAIL",
    "errorCode": "Internal server error",
    "errorMsg": "Internal server error"
  },
  {
    "result": "FAIL",
    "errorCode": "PermissionDenied",
    "errorMsg": "PermissionDenied view_tasks"
  },
  {
    "result": "FAIL",
    "errorCode": "InvalidParameter",
    "errorMsg": "InvalidParameter issueComment text empty"
  }
]

401

Returned if the authentication credentials are incorrect or missing.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Unauthorized",
  "errorMsg": "Access token is invalid"
}

403

Returns if the scope check fails.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Forbidden",
  "errorMsg": "Scope is invalid"
}

404

Returned if the resource object was not found.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "NotFound",
  "errorMsg": "Not Found"
}

500

Internal Server Error.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Internal Server Error",
  "errorMsg": "Internal Server Error"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://your-domain/openapi/v2/project/issues/:issueID/watchers' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "watchers": [
    "UoG2xQsS",
    "Hw7ex3bq"
  ]
}'

Request Collapse all

Base URL

https://your-domain/openapi/v2

Auth

Bearer Token

Parameters

issueID — pathrequired

teamID — queryrequired

Body required

{
  "watchers": [
    "UoG2xQsS",
    "Hw7ex3bq"
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!