Skip to content
Share2Us

Close one of the caller's support tickets with resolution feedback.

POST
/v1/support/{id}/close
curl --request POST \
  --url https://api.share2.us/v1/support/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/close \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "resolution_note": "example", "satisfaction_rating": 1, "feedback": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
resolution_note
required
string
>= 1 characters <= 4000 characters
satisfaction_rating

Optional satisfaction rating from 1 to 5.

integer
nullable >= 1 <= 5
feedback
string
<= 4000 characters
Examplegenerated
{
  "resolution_note": "example",
  "satisfaction_rating": 1,
  "feedback": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Refreshed ticket detail.

Media typeapplication/json
object
ticket
required
object
id
required
string format: uuid
account_id
string format: uuid
email
string format: email
subject
required
string
<= 200 characters
message
string
<= 20000 characters
status
required
string
Allowed values: open pending resolved closed merged
merged_into
string format: uuid
closed_by
string
Allowed values: user support
closed_at
string format: date-time
resolution_note
string
<= 4000 characters
satisfaction_rating
integer
>= 1 <= 5
resolution_feedback
string
<= 4000 characters
created_at
required
string format: date-time
updated_at
required
string format: date-time
message_count
integer
last_message_preview
string
last_author_type
string
Allowed values: user support system
messages
required
Array<object>
object
id
required
string format: uuid
ticket_id
string format: uuid
author_type
required
string
Allowed values: user support system
author_email
required
string format: email
body
required
string
<= 20000 characters
created_at
required
string format: date-time
activity
Array<object>
object
event_type
required
string
<= 120 characters
occurred_at
required
string format: date-time
share_public_id
string
<= 128 characters
description
string
<= 280 characters
attachments
Array<object>
object
id
required
string format: uuid
ticket_id
string format: uuid
message_id
string format: uuid
uploader_type
required
string
Allowed values: user support system
file_name
required
string
<= 180 characters
content_type
required
string
Allowed values: text/plain text/markdown application/pdf image/png image/jpeg application/zip
size_bytes
required
integer
<= 5242880
created_at
required
string format: date-time
attachments

Ticket-level attachments without an associated message.

Array<object>
object
id
required
string format: uuid
ticket_id
string format: uuid
message_id
string format: uuid
uploader_type
required
string
Allowed values: user support system
file_name
required
string
<= 180 characters
content_type
required
string
Allowed values: text/plain text/markdown application/pdf image/png image/jpeg application/zip
size_bytes
required
integer
<= 5242880
created_at
required
string format: date-time
Example
{
  "ticket": {
    "status": "open",
    "closed_by": "user",
    "last_author_type": "user"
  },
  "messages": [
    {
      "author_type": "user",
      "attachments": [
        {
          "uploader_type": "user",
          "content_type": "text/plain"
        }
      ]
    }
  ],
  "attachments": [
    {
      "uploader_type": "user",
      "content_type": "text/plain"
    }
  ]
}

409

Section titled “409”

Ticket is already closed or merged.

default

Section titled “default”

Standard error envelope.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
request_id
required
string
Example
{
  "error": {
    "code": "quota_exceeded"
  }
}