Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

/tickets.create | Document endpoint #780

Closed
wants to merge 3 commits into from
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
document /tickets.create endpoint
tiagobastos committed Jan 11, 2024
commit bda168523f8c6bcb7a1cbaf8baf118a09febfa22
39 changes: 39 additions & 0 deletions apiary.apib
Original file line number Diff line number Diff line change
@@ -8240,6 +8240,45 @@ Get a list of all mail templates.
+ work_order
+ credit_note

# Group Tickets

## Tickets [/tickets]

### tickets.create [POST /tickets.create]

Create a ticket.

+ Request (application/json)
+ Attributes (object)
+ subject: `My ticket subject` (string, required)
+ customer (object, required)
+ type: `company` (enum[string], required)
+ Members
+ contact
+ company
+ id: `f29abf48-337d-44b4-aad4-585f5277a456` (string, required)
+ ticket_status_id: `46156648-87c6-478d-8aa7-1dc3a00dacab` (string, required)
+ assignee (object, optional)
+ type (enum[string], required)
+ Members
+ `user`
+ id: `98b2863e-7b01-4232-82f5-ede1f0b9db22` (string, required)
+ custom_fields (array[CustomFieldValue], optional)
+ remarks: `My ticket details` (string, optional) - Uses Markdown formatting
+ participant (object, optional)
+ customer (object, required)
+ type (enum, required)
+ Members
+ `company`
+ id: `2659dc4d-444b-4ced-b51c-b87591f604d7` (string, required)

+ Response 201 (application/json)

+ Attributes (object)
+ data (object)
+ type: `ticket` (string)
+ id: `f29abf48-337d-44b4-aad4-585f5277a456` (string)

# Group Other

## Migrating [/migrate]
36 changes: 36 additions & 0 deletions src/13-tickets/tickets.apib
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## Tickets [/tickets]

### tickets.create [POST /tickets.create]

Create a ticket.

+ Request (application/json)
+ Attributes (object)
+ subject: `My ticket subject` (string, required)
+ customer (object, required)
+ type: `company` (enum[string], required)
+ Members
+ contact
+ company
+ id: `f29abf48-337d-44b4-aad4-585f5277a456` (string, required)
+ ticket_status_id: `46156648-87c6-478d-8aa7-1dc3a00dacab` (string, required)
+ assignee (object, optional)
+ type (enum[string], required)
+ Members
+ `user`
+ id: `98b2863e-7b01-4232-82f5-ede1f0b9db22` (string, required)
+ custom_fields (array[CustomFieldValue], optional)
+ remarks: `My ticket details` (string, optional) - Uses Markdown formatting
+ participant (object, optional)
+ customer (object, required)
+ type (enum, required)
+ Members
+ `company`
+ id: `2659dc4d-444b-4ced-b51c-b87591f604d7` (string, required)

+ Response 201 (application/json)

+ Attributes (object)
+ data (object)
+ type: `ticket` (string)
+ id: `f29abf48-337d-44b4-aad4-585f5277a456` (string)
4 changes: 4 additions & 0 deletions src/apiary.apib
Original file line number Diff line number Diff line change
@@ -135,6 +135,10 @@ HOST: https://api.focus.teamleader.eu

:[Mail Templates](./11-templates/mail-templates.apib)

# Group Tickets

:[Tickets](./13-tickets/tickets.apib)

# Group Other

:[Migrating](./99-other/migrating.apib)