Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-131569135.4 KB
Tickets

Create Ticket

Create Ticket

post/issue-tracking/collections/{collection_id}/tickets

Path parameters

collection_idstring required
Example:apideck-io

The collection ID

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 required

A unique identifier for an object.

parent_idstring nullable

The ticket's parent ID

collection_idstring nullable

The ticket's collection ID

typestring nullable

The ticket's type

subjectstring nullable

Subject of the ticket

descriptionstring nullable

The ticket's description. HTML version of description is mapped if supported by the third-party platform

statusstring nullable

The current status of the ticket. Possible values include: open, in_progress, closed, or - in cases where there is no clear mapping - the original value passed through.

priority'low' | 'normal' | 'high' | 'urgent' nullable

Priority of the ticket

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.

created_bystring nullable

The user who created the object.

due_datestring date-time nullable

Due date of the ticket

completed_atstring date-time nullable

When the ticket was completed

custom_mappingsCustomMappings nullable

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

Example request

{
  "id": "12345",
  "parent_id": "12345",
  "collection_id": "12345",
  "type": "Technical",
  "subject": "Technical Support Request",
  "description": "I am facing issues with my internet connection",
  "status": "open",
  "priority": "high",
  "assignees": [
    {
      "id": "12345",
      "username": "Cocoa"
    }
  ],
  "updated_at": "2020-09-30T07:43:32.000Z",
  "created_at": "2020-09-30T07:43:32.000Z",
  "created_by": "12345",
  "due_date": "2020-09-30T07:43:32.000Z",
  "completed_at": "2020-09-30T07:43:32.000Z",
  "tags": [
    {
      "id": "12345",
      "name": "User Experience"
    }
  ],
  "pass_through": [
    {
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response

Create a Ticket

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": "jira",
  "resource": "Tickets",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}