Create a support ticket
Create a support ticket for a Moov account.
To access this endpoint using an access token
you'll need to specify the /accounts/{accountID}/tickets.write
scope.
If you're creating the ticket on behalf of another account, then you'll need to
specify the /accounts/{partnerAccountID}/tickets.write
and /accounts/{accountID}/profile.read
scopes.
POST
/accounts/{accountID}/tickets
|
|
|
|
|
|
|
|
|
|
The request completed successfully.
{
"ticketID": "string",
"number": 0,
"title": "string",
"contact": {
"email": "string",
"name": "string"
},
"status": "new",
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z",
"latestMessageOn": "2019-08-24T14:15:22Z",
"closedOn": "2019-08-24T14:15:22Z"
}
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The server could not understand the request due to invalid syntax.
{
"error": "string"
}
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request contained missing or expired authentication.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The user is not authorized to make the request.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The requested resource was not found.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request conflicted with the current state of the target resource.
{
"error": "string"
}
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request was well-formed, but the contents failed validation. Check the request for missing or invalid fields.
{
"title": "string",
"body": "string",
"contact": {
"email": "string",
"name": "string"
}
}
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
Request was refused due to rate limiting.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request failed due to an unexpected error.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
Headers
x-moov-version
string
API version
Specify an API version.
API versioning follows the format vYYYY.QQ.BB
, where
YYYY
is the yearQQ
is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)BB
is the build number, starting at.01
, for subsequent builds in the same quarter.- For example,
v2024.01.00
is the initial release of the first quarter of 2024.
- For example,
The latest
version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
Default:
v2024.01.00
Path parameters
accountID
string
<uuid>
required
Body
application/json
body
string<html>
required
contact
object
required
Show child attributes
string
required
name
string
title
string
required
Response
application/json
contact
object
required
Show child attributes
string
required
name
string
createdOn
string<date-time>
required
number
integer
required
status
string<enum>
required
Possible values:
new
,
in-progress
,
on-hold
,
closed
ticketID
string
required
title
string
required
updatedOn
string<date-time>
required
closedOn
string<date-time>
latestMessageOn
string<date-time>