v1

latestOpenAPI 3.0.0Apache 2.02026-07-131569135.4 KB

Comments

Update Comment

patch/issue-tracking/collections/{collection_id}/tickets/{ticket_id}/comments/{id}

Path parameters

idstring required

ID of the record you are acting upon.

collection_idstring required

Example:apideck-io

The collection ID

ticket_idstring required

ID of the ticket you are acting upon.

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Request body

idstring

A unique identifier for an object.

bodystring nullable

Body of the comment

custom_mappingsCustomMappings nullable

When custom mappings are configured on the resource, the result is included here.

created_bystring nullable

The user who created the object.

updated_atstring date-time nullable

The date and time when the object was last updated.

created_atstring date-time nullable

The date and time when the object was created.

Example request

{
  "id": "12345",
  "body": "What internet provider do you use?",
  "created_by": "12345",
  "updated_at": "2020-09-30T07:43:32.000Z",
  "created_at": "2020-09-30T07:43:32.000Z",
  "pass_through": [
    {
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response

Update a Comment

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "github",
  "resource": "Tickets",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}