> For the complete documentation index, see [llms.txt](https://docs.sumble.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sumble.com/api/support.md).

# Support

Report data quality issues and submit general support requests programmatically — the same flow used by the **Report data issue** button in the web app.

Both endpoints are free (no credits consumed) and authenticated the same way as the rest of the API. The reply-to address on every email is set to your account's email so the Sumble team can follow up with you directly.

## Report a data quality issue

Report incorrect, missing, or stale Sumble data. Routed to the Sumble data team for triage.

```bash
curl https://api.sumble.com/v9/support/data-quality \
  --request POST \
  --header "Authorization: Bearer $API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
    "message": "The employee count for Acme looks stale",
    "url": "https://sumble.com/org/acme",
    "page_title": "Acme | Sumble"
  }'
```

### Request body

| Field        | Type   | Required | Description                                        |
| ------------ | ------ | -------- | -------------------------------------------------- |
| `message`    | string | Yes      | Description of the issue. Max 5,000 characters.    |
| `url`        | string | No       | The Sumble URL the issue relates to, if any.       |
| `page_title` | string | No       | The title of the Sumble page the issue relates to. |

### Response

```json
{ "message": "Email sent successfully" }
```

## Create Data Quality Report

> Report a data quality issue. Routed to the data team for triage.

```json
{"openapi":"3.1.0","info":{"title":"Sumble API","version":"v9"},"servers":[{"url":"https://api.sumble.com"}],"security":[{"api_token":[]}],"components":{"securitySchemes":{"api_token":{"type":"http","scheme":"bearer"}},"schemas":{"CreateDataQualityReportRequest":{"properties":{"message":{"type":"string","maxLength":5000,"title":"Message"},"url":{"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}],"title":"Url"},"page_title":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Page Title"}},"type":"object","required":["message"],"title":"CreateDataQualityReportRequest"},"SupportRequestResponse":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"SupportRequestResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/v9/support/data-quality":{"post":{"tags":["support"],"summary":"Create Data Quality Report","description":"Report a data quality issue. Routed to the data team for triage.","operationId":"create_data_quality_report__api_version__support_data_quality_post","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDataQualityReportRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportRequestResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Submit a general support request

Submit an account, billing, or product question. Routed to the Sumble support inbox.

```bash
curl https://api.sumble.com/v9/support \
  --request POST \
  --header "Authorization: Bearer $API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
    "message": "How do I update my billing details?",
    "url": "https://sumble.com/account/billing"
  }'
```

### Request body

| Field     | Type   | Required | Description                                       |
| --------- | ------ | -------- | ------------------------------------------------- |
| `message` | string | Yes      | Description of the request. Max 5,000 characters. |
| `url`     | string | No       | The Sumble URL the request relates to, if any.    |

### Response

```json
{ "message": "Email sent successfully" }
```

## Create Support Request

> Submit a general support request.

```json
{"openapi":"3.1.0","info":{"title":"Sumble API","version":"v9"},"servers":[{"url":"https://api.sumble.com"}],"security":[{"api_token":[]}],"components":{"securitySchemes":{"api_token":{"type":"http","scheme":"bearer"}},"schemas":{"CreateSupportRequestRequest":{"properties":{"message":{"type":"string","maxLength":5000,"title":"Message"},"url":{"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}],"title":"Url"}},"type":"object","required":["message"],"title":"CreateSupportRequestRequest"},"SupportRequestResponse":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"SupportRequestResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/v9/support":{"post":{"tags":["support"],"summary":"Create Support Request","description":"Submit a general support request.","operationId":"create_support_request__api_version__support_post","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSupportRequestRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportRequestResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```