Create an Issue
2min
POST
AUTHENTICATION
Authorization
string
Bearer
BODY PARAMETERS
body
object
address_id
integer
*The ID of the `Address` that the `Issue` occured
description
string
*The description of what the `Issue` is
type
string<damage | low_inventory>
*The type of `Issue` that was reported. Either `damage` or `low_inventory`
RESPONSES
200
OK
Issue
## About Issues
Issues can be reported about an `Address`. Issues are things that happen at the property that needs follow up from you. They can be reported either by the `Pro` on the `Job` or by someone on your account.
## More details about Issues
| Attribute | Description |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id | The ID of the `Issue` |
| address_id | The ID of the `Address` that the `Issue` occured |
| description | The description of what the `Issue` is |
| reporter_type | Who reported the `Issue`.
**customer** - The `Issue` was created by the customer account.
**pro** - The `Issue` was created by the `Pro` on a `Job`. | | status | Status of the `Issue`.
**open** - The `Issue` is open and needs resolution.
**resolved** - The `Issue` is resolved, no further action needed. | | type | The type of `Issue` that was reported.
**damage** - The `Issue` is damage related.
**low_inventory** - The `Issue` is related to low inventory.` | | created_at | The date and time the `Issue` was created. UTC and ISO formatted. | |
**customer** - The `Issue` was created by the customer account.
**pro** - The `Issue` was created by the `Pro` on a `Job`. | | status | Status of the `Issue`.
**open** - The `Issue` is open and needs resolution.
**resolved** - The `Issue` is resolved, no further action needed. | | type | The type of `Issue` that was reported.
**damage** - The `Issue` is damage related.
**low_inventory** - The `Issue` is related to low inventory.` | | created_at | The date and time the `Issue` was created. UTC and ISO formatted. | |
object
string
*id
integer
*The ID of the `Issue`
address_id
integer
*The ID of the `Address` that the `Issue` occured
description
string
*The description of what the `Issue` is
reporter_type
string< | pro | customer>
*Who reported the `Issue`.
**customer** - The `Issue` was created by the customer account.
**pro** - The `Issue` was created by the `Pro` on a `Job`.
**customer** - The `Issue` was created by the customer account.
**pro** - The `Issue` was created by the `Pro` on a `Job`.
status
string<open | resolved>
*Status of the `Issue`.
**open** - The `Issue` is open and needs resolution.
**resolved** - The `Issue` is resolved, no further action needed.
**open** - The `Issue` is open and needs resolution.
**resolved** - The `Issue` is resolved, no further action needed.
type
string<damage | low_inventory>
*The type of `Issue` that was reported. Either `damage` or `low_inventory`
created_at
string
*The date and time the `Issue` was created. UTC and ISO formatted.
Updated 26 Apr 2023
Did this page help you?
Yes
No