API Reference
/
Connector API
/
Ticketing
/
Create Note

Connector API

The Synqly Connector APIs provide a unifying interface and data model for all supported service Providers.

See the Synqly Overview for more information.

Download OpenAPI description
connectors.json
connectors.yaml
Languages
Servers
Synqly
https://api.synqly.com/

Assets

Operations

Edr

Operations

Hooks

Operations

Identity

Operations

Notifications

Operations

Operations (In Development)

In Development

This feature is actively being developed. Breaking changes should be expected.

Please contact us before using this feature.

Operations

Siem

Operations

Sink

Operations

Storage

Operations

Ticketing

Operations

Delete Comment

Request

Deletes the comment matching {commentId} form the ticket matching {ticketId} from the token-linked Integration.

Path
ticketIdstring(Id)required
commentIdstring(Id)required
curl -i -X DELETE \
  'https://api.synqly.com/v1/ticketing/tickets/{ticketId}/comments/{commentId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response
No content

Create Note

Request

Creates a note on the ticket matching {ticketId} from the token-linked Integration.

Path
ticketIdstring(Id)required
Bodyapplication/jsonrequired
contentstringrequired

The content of the note formatted as markdown.

titlestringrequired

The title of the note.

curl -i -X POST \
  'https://api.synqly.com/v1/ticketing/tickets/{ticketId}/notes' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "content": "string",
    "title": "string"
  }'

Responses

Bodyapplication/json
resultobject(Note)required

Note on a ticket

result.​idstring(Id)required
result.​ticket_idstring(Id)required
result.​contentstringrequired

The content of the note formatted as markdown.

result.​creatorstringrequired

The user who created the note.

result.​titlestringrequired

The title of the note.

result.​created_atstring(date-time)required

The date the comment was created.

result.​updated_atstring or null(date-time)

The date the comment was last updated.

result.​unmappedobject(Object)

The Object type is used to represent an object with arbitrary fields. The keys are strings and the values are any type.

Response
application/json
{
  "result": {
    "id": "string",
    "ticket_id": "string",
    "content": "string",
    "creator": "string",
    "title": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "unmapped": {}
  }
}

List Notes

Request

Lists all notes for the ticket matching {ticketId} from the token-linked Integration.

Path
ticketIdstring(Id)required
curl -i -X GET \
  'https://api.synqly.com/v1/ticketing/tickets/{ticketId}/notes' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
resultArray of objects(Note)required
result[].​idstring(Id)required
result[].​ticket_idstring(Id)required
result[].​contentstringrequired

The content of the note formatted as markdown.

result[].​creatorstringrequired

The user who created the note.

result[].​titlestringrequired

The title of the note.

result[].​created_atstring(date-time)required

The date the comment was created.

result[].​updated_atstring or null(date-time)

The date the comment was last updated.

result[].​unmappedobject(Object)

The Object type is used to represent an object with arbitrary fields. The keys are strings and the values are any type.

Response
application/json
{
  "result": [
    { … }
  ]
}

Vulnerabilities

Operations