Create Support Ticket

Posts a new note to the Support Ticket ID provided in the path.

For more information see the SupportTicketNoteRequest Model.

Path parameters

supportTicketIdlongRequired

Request

This endpoint expects an object.

notestringRequiredformat: "\S"

The note to post to the Support Ticket.

Response

This endpoint returns an object.

idlongOptional

The ID of the Support Ticket.

customerobjectOptional

The Customer to whom this Support Ticket belongs.

patientobjectOptional

The Patient that the Support Ticket involves, if applicable.

orderobjectOptional

The Order that the Support Ticket involves, if applicable.

deviceobjectOptional

The Device that the Support Ticket involves, if applicable.

siteobjectOptional

The Site that the Support Ticket involves, if applicable.

ticketTypestringOptional

The type of Support Ticket.

supportTicketNoteslist of objectsOptional

A list of all SupportTicketNotes attached to this Support Ticket.

supportTicketEventslist of objectsOptional

A list of all SupportTicketEvents attached to this Support Ticket.

currentStatusstringOptional

The current status of the Support Ticket.

openbooleanOptional

Whether or not the ticket is considered open or closed.

assignedTeamstringOptional

The team that’s assigned this Support Ticket, if any.

assigneeobjectOptional

The EndUser assigned to this Support Ticket, if any.

createdByobjectOptional

The creator of this Support Ticket.

createdAtdatetimeOptional

The timestamp when the Support Ticket was created.

lastUpdateddatetimeOptional

The most recent time that this Support Ticket was updated in some form.

1 curl -X POST https://app.impiloplatform.com/api/v3/support-ticket/1000000/note \ 2 -H "Impilo-API-Key: <apiKey>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "note": "Example Note" 6 }'

1 { 2 "id": 1000000, 3 "customer": { 4 "id": 1000000, 5 "name": "name" 6 }, 7 "patient": { 8 "firstName": "John", 9 "lastName": "Doe", 10 "id": 1, 11 "externalIdentifier": "1234abcd", 12 "dateOfBirth": "1980-01-01", 13 "email": "john.doe@example.com", 14 "phoneNumber": "+1234567890", 15 "archived": true, 16 "address": { 17 "lineOne": "lineOne", 18 "city": "city", 19 "state": "state", 20 "zipCode": "zipCode", 21 "country": "country", 22 "lineTwo": "lineTwo", 23 "lineThree": "lineThree", 24 "note": "note" 25 }, 26 "site": { 27 "id": 1, 28 "name": "name", 29 "active": true, 30 "address": { 31 "lineOne": "lineOne", 32 "city": "city", 33 "state": "state", 34 "zipCode": "zipCode", 35 "country": "country" 36 } 37 }, 38 "enrolled": true, 39 "sex": "other" 40 }, 41 "order": { 42 "id": 1000000, 43 "externalOrderIds": [ 44 "externalOrderIds" 45 ], 46 "patient": { 47 "firstName": "John", 48 "lastName": "Doe", 49 "id": 1, 50 "externalIdentifier": "1234abcd", 51 "dateOfBirth": "1980-01-01", 52 "email": "john.doe@example.com", 53 "phoneNumber": "+1234567890", 54 "archived": true, 55 "address": { 56 "lineOne": "lineOne", 57 "city": "city", 58 "state": "state", 59 "zipCode": "zipCode", 60 "country": "country" 61 }, 62 "site": { 63 "id": 1 64 }, 65 "enrolled": true, 66 "sex": "other" 67 }, 68 "site": { 69 "id": 1, 70 "name": "name", 71 "active": true, 72 "address": { 73 "lineOne": "lineOne", 74 "city": "city", 75 "state": "state", 76 "zipCode": "zipCode", 77 "country": "country" 78 } 79 }, 80 "currentStatus": "availableForPickup", 81 "orderItems": [ 82 {} 83 ], 84 "orderKits": [ 85 {} 86 ], 87 "orderEvents": [ 88 {} 89 ], 90 "trackingNumbers": [ 91 {} 92 ], 93 "devices": [ 94 { 95 "id": 1, 96 "currentPatient": { 97 "firstName": "John", 98 "lastName": "Doe", 99 "id": 1, 100 "externalIdentifier": "1234abcd", 101 "dateOfBirth": "1980-01-01", 102 "email": "john.doe@example.com", 103 "phoneNumber": "+1234567890", 104 "archived": true 105 } 106 } 107 ], 108 "packedKits": [ 109 {} 110 ], 111 "shippingOption": "standard" 112 }, 113 "device": { 114 "id": 1, 115 "item": { 116 "id": 1, 117 "manufacturer": { 118 "id": 1 119 }, 120 "name": "name", 121 "model": "model", 122 "sku": "sku", 123 "orderable": true 124 }, 125 "currentStatus": "currentStatus", 126 "used": true, 127 "currentPatient": { 128 "firstName": "John", 129 "lastName": "Doe", 130 "id": 1, 131 "externalIdentifier": "1234abcd", 132 "dateOfBirth": "1980-01-01", 133 "email": "john.doe@example.com", 134 "phoneNumber": "+1234567890", 135 "archived": true, 136 "address": { 137 "lineOne": "lineOne", 138 "city": "city", 139 "state": "state", 140 "zipCode": "zipCode", 141 "country": "country" 142 }, 143 "site": { 144 "id": 1 145 }, 146 "enrolled": true, 147 "sex": "other" 148 }, 149 "site": { 150 "id": 1, 151 "name": "name", 152 "active": true, 153 "address": { 154 "lineOne": "lineOne", 155 "city": "city", 156 "state": "state", 157 "zipCode": "zipCode", 158 "country": "country" 159 } 160 }, 161 "lastHealthCheck": "lastHealthCheck", 162 "deviceIdentifiers": [ 163 {} 164 ], 165 "deviceEvents": [ 166 {} 167 ], 168 "externalIdentifier": "externalIdentifier", 169 "disabledReadings": true 170 }, 171 "site": { 172 "id": 1, 173 "name": "name", 174 "active": true, 175 "address": { 176 "lineOne": "lineOne", 177 "city": "city", 178 "state": "state", 179 "zipCode": "zipCode", 180 "country": "country", 181 "lineTwo": "lineTwo", 182 "lineThree": "lineThree", 183 "note": "note" 184 } 185 }, 186 "ticketType": "ticketType", 187 "supportTicketNotes": [ 188 { 189 "note": "note", 190 "createdAt": "2022-03-10T16:15:50Z" 191 } 192 ], 193 "supportTicketEvents": [ 194 { 195 "eventType": "eventType", 196 "createdAt": "2022-03-10T16:15:50Z" 197 } 198 ], 199 "currentStatus": "currentStatus", 200 "open": true, 201 "assignedTeam": "assignedTeam", 202 "assignee": { 203 "id": 1000000, 204 "firstName": "firstName", 205 "lastName": "lastName", 206 "email": "email" 207 }, 208 "createdBy": { 209 "id": 1000000, 210 "firstName": "firstName", 211 "lastName": "lastName", 212 "email": "email" 213 }, 214 "createdAt": "2022-03-10T16:15:50Z", 215 "lastUpdated": "2022-03-10T16:15:50Z" 216 }

1	curl -X POST https://app.impiloplatform.com/api/v3/support-ticket/1000000/note \
2	-H "Impilo-API-Key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"note": "Example Note"
6	}'

1	{
2	"id": 1000000,
3	"customer": {
4	"id": 1000000,
5	"name": "name"
6	},
7	"patient": {
8	"firstName": "John",
9	"lastName": "Doe",
10	"id": 1,
11	"externalIdentifier": "1234abcd",
12	"dateOfBirth": "1980-01-01",
13	"email": "john.doe@example.com",
14	"phoneNumber": "+1234567890",
15	"archived": true,
16	"address": {
17	"lineOne": "lineOne",
18	"city": "city",
19	"state": "state",
20	"zipCode": "zipCode",
21	"country": "country",
22	"lineTwo": "lineTwo",
23	"lineThree": "lineThree",
24	"note": "note"
25	},
26	"site": {
27	"id": 1,
28	"name": "name",
29	"active": true,
30	"address": {
31	"lineOne": "lineOne",
32	"city": "city",
33	"state": "state",
34	"zipCode": "zipCode",
35	"country": "country"
36	}
37	},
38	"enrolled": true,
39	"sex": "other"
40	},
41	"order": {
42	"id": 1000000,
43	"externalOrderIds": [
44	"externalOrderIds"
45	],
46	"patient": {
47	"firstName": "John",
48	"lastName": "Doe",
49	"id": 1,
50	"externalIdentifier": "1234abcd",
51	"dateOfBirth": "1980-01-01",
52	"email": "john.doe@example.com",
53	"phoneNumber": "+1234567890",
54	"archived": true,
55	"address": {
56	"lineOne": "lineOne",
57	"city": "city",
58	"state": "state",
59	"zipCode": "zipCode",
60	"country": "country"
61	},
62	"site": {
63	"id": 1
64	},
65	"enrolled": true,
66	"sex": "other"
67	},
68	"site": {
69	"id": 1,
70	"name": "name",
71	"active": true,
72	"address": {
73	"lineOne": "lineOne",
74	"city": "city",
75	"state": "state",
76	"zipCode": "zipCode",
77	"country": "country"
78	}
79	},
80	"currentStatus": "availableForPickup",
81	"orderItems": [
82	{}
83	],
84	"orderKits": [
85	{}
86	],
87	"orderEvents": [
88	{}
89	],
90	"trackingNumbers": [
91	{}
92	],
93	"devices": [
94	{
95	"id": 1,
96	"currentPatient": {
97	"firstName": "John",
98	"lastName": "Doe",
99	"id": 1,
100	"externalIdentifier": "1234abcd",
101	"dateOfBirth": "1980-01-01",
102	"email": "john.doe@example.com",
103	"phoneNumber": "+1234567890",
104	"archived": true
105	}
106	}
107	],
108	"packedKits": [
109	{}
110	],
111	"shippingOption": "standard"
112	},
113	"device": {
114	"id": 1,
115	"item": {
116	"id": 1,
117	"manufacturer": {
118	"id": 1
119	},
120	"name": "name",
121	"model": "model",
122	"sku": "sku",
123	"orderable": true
124	},
125	"currentStatus": "currentStatus",
126	"used": true,
127	"currentPatient": {
128	"firstName": "John",
129	"lastName": "Doe",
130	"id": 1,
131	"externalIdentifier": "1234abcd",
132	"dateOfBirth": "1980-01-01",
133	"email": "john.doe@example.com",
134	"phoneNumber": "+1234567890",
135	"archived": true,
136	"address": {
137	"lineOne": "lineOne",
138	"city": "city",
139	"state": "state",
140	"zipCode": "zipCode",
141	"country": "country"
142	},
143	"site": {
144	"id": 1
145	},
146	"enrolled": true,
147	"sex": "other"
148	},
149	"site": {
150	"id": 1,
151	"name": "name",
152	"active": true,
153	"address": {
154	"lineOne": "lineOne",
155	"city": "city",
156	"state": "state",
157	"zipCode": "zipCode",
158	"country": "country"
159	}
160	},
161	"lastHealthCheck": "lastHealthCheck",
162	"deviceIdentifiers": [
163	{}
164	],
165	"deviceEvents": [
166	{}
167	],
168	"externalIdentifier": "externalIdentifier",
169	"disabledReadings": true
170	},
171	"site": {
172	"id": 1,
173	"name": "name",
174	"active": true,
175	"address": {
176	"lineOne": "lineOne",
177	"city": "city",
178	"state": "state",
179	"zipCode": "zipCode",
180	"country": "country",
181	"lineTwo": "lineTwo",
182	"lineThree": "lineThree",
183	"note": "note"
184	}
185	},
186	"ticketType": "ticketType",
187	"supportTicketNotes": [
188	{
189	"note": "note",
190	"createdAt": "2022-03-10T16:15:50Z"
191	}
192	],
193	"supportTicketEvents": [
194	{
195	"eventType": "eventType",
196	"createdAt": "2022-03-10T16:15:50Z"
197	}
198	],
199	"currentStatus": "currentStatus",
200	"open": true,
201	"assignedTeam": "assignedTeam",
202	"assignee": {
203	"id": 1000000,
204	"firstName": "firstName",
205	"lastName": "lastName",
206	"email": "email"
207	},
208	"createdBy": {
209	"id": 1000000,
210	"firstName": "firstName",
211	"lastName": "lastName",
212	"email": "email"
213	},
214	"createdAt": "2022-03-10T16:15:50Z",
215	"lastUpdated": "2022-03-10T16:15:50Z"
216	}