Skip to content
SoundSyncAudio software platform

API reference

Support Content API

Configure support contact routing, published articles, escalation copy and optional assistance settings.

One support identity, several destinations

Read settings and resolver before saving. supportEmail is the public contact. contactFormDestinationEmail is a delivery override; when absent, delivery can resolve the public-email fallback. supportUrlOverride only takes effect with its supported enabled setting. Saving a destination does not prove the mailbox exists or that delivery succeeded.

Save the fields the support service accepts

Send flat supported settings: supportEmail, businessAddress, supportPhone, primaryContactName, supportDisplayName, supportContactLabel, responseTimeMessage, availabilityMessage, contactFormEnabled, contactFormDestinationEmail, supportUrlOverride, supportUrlOverrideEnabled and supportPageEnabled.

Optional assistance settings include aiAssistantEnabled, aiAssistantTone, escalationMessage and alwaysEscalateWhenUnsure. They configure behavior; they do not guarantee a response time, autonomous resolution or availability of an AI provider. Publish only response and availability copy you can actually honor.

Articles and saves

Articles use type, title, body, optional productId, sortOrder and visible. Supported types are faq, install, activation, download, compatibility, policy, known_issue and troubleshooting. PUT and PATCH share the same normalization service rather than implementing generic JSON Patch. When articles are supplied, review the complete replacement list; omitted articles are not a safe way to preserve an existing set.

Reading requires customers.view and all-products workspace scope. Saving additionally requires settings.manage, held by owners and administrators. Customer Support staff retain their support access but cannot reroute the global contact form or disable the support page. This is not a public unauthenticated support-settings API. Reload settings, articles and resolver after saving; a content save does not change an entitlement or send a customer message.

Draft assistance is not publication

The support-items action uses the product setup AI service and returns a draft ID, suggestions and any persistence warning. Review FAQ answers, installation copy and troubleshooting before saving articles. Operational support replies use the separate Operational AI API and draft store; neither endpoint sends a customer reply.

SoundSync

Support workflow

Support guide

Contact forms, articles and customer context.

Customer recovery API

Private notes, access messages and device resets.

SoundSync

Requests and responses

GET /api/developer/support

Read developer support content and routing

Auth
Account Bearer session token
Scope
customers.view and all-products workspace scope.
Returns
HTTP 200: settings, articles, requests, legacy, resolver, source.
Request, response and error reference

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "settings": {
      "type": "object",
      "properties": {
        "supportEmail": {
          "type": "string"
        },
        "businessAddress": {
          "type": "string"
        },
        "supportPhone": {
          "type": "string"
        },
        "primaryContactName": {
          "type": "string"
        },
        "supportUrlOverride": {
          "type": "string"
        },
        "supportUrlOverrideEnabled": {
          "type": "boolean"
        },
        "supportDisplayName": {
          "type": "string"
        },
        "supportContactLabel": {
          "type": "string"
        },
        "responseTimeMessage": {
          "type": "string"
        },
        "availabilityMessage": {
          "type": "string"
        },
        "contactFormEnabled": {
          "type": "boolean"
        },
        "contactFormDestinationEmail": {
          "type": "string"
        },
        "aiAssistantEnabled": {
          "type": "boolean"
        },
        "aiAssistantTone": {
          "type": "string"
        },
        "escalationMessage": {
          "type": "string"
        },
        "alwaysEscalateWhenUnsure": {
          "type": "boolean"
        },
        "supportPageEnabled": {
          "type": "boolean"
        }
      },
      "additionalProperties": true
    },
    "articles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": [
              "integer",
              "null"
            ]
          },
          "productId": {
            "type": [
              "integer",
              "null"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "faq",
              "install",
              "activation",
              "download",
              "compatibility",
              "policy",
              "known_issue",
              "troubleshooting"
            ]
          },
          "title": {
            "type": "string"
          },
          "body": {
            "type": "string"
          },
          "sortOrder": {
            "type": "integer"
          },
          "visible": {
            "type": "boolean"
          },
          "createdAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "updatedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        },
        "additionalProperties": true
      }
    },
    "requests": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": [
              "integer",
              "null"
            ]
          },
          "developerId": {
            "type": [
              "integer",
              "null"
            ]
          },
          "customerId": {
            "type": [
              "integer",
              "null"
            ]
          },
          "productId": {
            "type": [
              "integer",
              "null"
            ]
          },
          "email": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "issueType": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "context": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          },
          "status": {
            "type": "string",
            "enum": [
              "new",
              "open",
              "waiting",
              "closed"
            ]
          },
          "createdAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "updatedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        },
        "additionalProperties": true
      }
    },
    "legacy": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "resolver": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "source": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

PUT /api/developer/support

Save support content and articles

Auth
Account Bearer session token
Scope
customers.view plus settings.manage and all-products workspace scope. Only owner and administrator roles have settings.manage.
Request fields
  • supportEmail: string
  • businessAddress: string
  • supportPhone: string
  • primaryContactName: string
  • supportUrlOverride: string
  • supportUrlOverrideEnabled: boolean
  • supportDisplayName: string
  • supportContactLabel: string
  • responseTimeMessage: string
  • availabilityMessage: string
  • contactFormEnabled: boolean
  • contactFormDestinationEmail: string
  • aiAssistantEnabled: boolean
  • aiAssistantTone: string
  • escalationMessage: string
  • alwaysEscalateWhenUnsure: boolean
  • supportPageEnabled: boolean
  • articles: array
Returns
HTTP 200: settings, articles, requests, legacy, resolver, source.
Notes
These compatibility save handlers share the same service; PATCH is not a promise of generic JSON Patch semantics. Read the normalization rules and reload the saved result. Article content and contact routing do not change product entitlements.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "supportEmail": {
      "type": "string"
    },
    "businessAddress": {
      "type": "string"
    },
    "supportPhone": {
      "type": "string"
    },
    "primaryContactName": {
      "type": "string"
    },
    "supportUrlOverride": {
      "type": "string"
    },
    "supportUrlOverrideEnabled": {
      "type": "boolean"
    },
    "supportDisplayName": {
      "type": "string"
    },
    "supportContactLabel": {
      "type": "string"
    },
    "responseTimeMessage": {
      "type": "string"
    },
    "availabilityMessage": {
      "type": "string"
    },
    "contactFormEnabled": {
      "type": "boolean"
    },
    "contactFormDestinationEmail": {
      "type": "string"
    },
    "aiAssistantEnabled": {
      "type": "boolean"
    },
    "aiAssistantTone": {
      "type": "string"
    },
    "escalationMessage": {
      "type": "string"
    },
    "alwaysEscalateWhenUnsure": {
      "type": "boolean"
    },
    "supportPageEnabled": {
      "type": "boolean"
    },
    "articles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": [
              "integer",
              "null"
            ]
          },
          "productId": {
            "type": [
              "integer",
              "null"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "faq",
              "install",
              "activation",
              "download",
              "compatibility",
              "policy",
              "known_issue",
              "troubleshooting"
            ]
          },
          "title": {
            "type": "string"
          },
          "body": {
            "type": "string"
          },
          "sortOrder": {
            "type": "integer"
          },
          "visible": {
            "type": "boolean"
          },
          "createdAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "updatedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        },
        "additionalProperties": true
      }
    }
  },
  "additionalProperties": true
}

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "settings": {
      "type": "object",
      "properties": {
        "supportEmail": {
          "type": "string"
        },
        "businessAddress": {
          "type": "string"
        },
        "supportPhone": {
          "type": "string"
        },
        "primaryContactName": {
          "type": "string"
        },
        "supportUrlOverride": {
          "type": "string"
        },
        "supportUrlOverrideEnabled": {
          "type": "boolean"
        },
        "supportDisplayName": {
          "type": "string"
        },
        "supportContactLabel": {
          "type": "string"
        },
        "responseTimeMessage": {
          "type": "string"
        },
        "availabilityMessage": {
          "type": "string"
        },
        "contactFormEnabled": {
          "type": "boolean"
        },
        "contactFormDestinationEmail": {
          "type": "string"
        },
        "aiAssistantEnabled": {
          "type": "boolean"
        },
        "aiAssistantTone": {
          "type": "string"
        },
        "escalationMessage": {
          "type": "string"
        },
        "alwaysEscalateWhenUnsure": {
          "type": "boolean"
        },
        "supportPageEnabled": {
          "type": "boolean"
        }
      },
      "additionalProperties": true
    },
    "articles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": [
              "integer",
              "null"
            ]
          },
          "productId": {
            "type": [
              "integer",
              "null"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "faq",
              "install",
              "activation",
              "download",
              "compatibility",
              "policy",
              "known_issue",
              "troubleshooting"
            ]
          },
          "title": {
            "type": "string"
          },
          "body": {
            "type": "string"
          },
          "sortOrder": {
            "type": "integer"
          },
          "visible": {
            "type": "boolean"
          },
          "createdAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "updatedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        },
        "additionalProperties": true
      }
    },
    "requests": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": [
              "integer",
              "null"
            ]
          },
          "developerId": {
            "type": [
              "integer",
              "null"
            ]
          },
          "customerId": {
            "type": [
              "integer",
              "null"
            ]
          },
          "productId": {
            "type": [
              "integer",
              "null"
            ]
          },
          "email": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "issueType": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "context": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          },
          "status": {
            "type": "string",
            "enum": [
              "new",
              "open",
              "waiting",
              "closed"
            ]
          },
          "createdAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "updatedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        },
        "additionalProperties": true
      }
    },
    "legacy": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "resolver": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "source": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

PATCH /api/developer/support

Save support content and articles

Auth
Account Bearer session token
Scope
customers.view plus settings.manage and all-products workspace scope. Only owner and administrator roles have settings.manage.
Request fields
  • supportEmail: string
  • businessAddress: string
  • supportPhone: string
  • primaryContactName: string
  • supportUrlOverride: string
  • supportUrlOverrideEnabled: boolean
  • supportDisplayName: string
  • supportContactLabel: string
  • responseTimeMessage: string
  • availabilityMessage: string
  • contactFormEnabled: boolean
  • contactFormDestinationEmail: string
  • aiAssistantEnabled: boolean
  • aiAssistantTone: string
  • escalationMessage: string
  • alwaysEscalateWhenUnsure: boolean
  • supportPageEnabled: boolean
  • articles: array
Returns
HTTP 200: settings, articles, requests, legacy, resolver, source.
Notes
These compatibility save handlers share the same service; PATCH is not a promise of generic JSON Patch semantics. Read the normalization rules and reload the saved result. Article content and contact routing do not change product entitlements.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "supportEmail": {
      "type": "string"
    },
    "businessAddress": {
      "type": "string"
    },
    "supportPhone": {
      "type": "string"
    },
    "primaryContactName": {
      "type": "string"
    },
    "supportUrlOverride": {
      "type": "string"
    },
    "supportUrlOverrideEnabled": {
      "type": "boolean"
    },
    "supportDisplayName": {
      "type": "string"
    },
    "supportContactLabel": {
      "type": "string"
    },
    "responseTimeMessage": {
      "type": "string"
    },
    "availabilityMessage": {
      "type": "string"
    },
    "contactFormEnabled": {
      "type": "boolean"
    },
    "contactFormDestinationEmail": {
      "type": "string"
    },
    "aiAssistantEnabled": {
      "type": "boolean"
    },
    "aiAssistantTone": {
      "type": "string"
    },
    "escalationMessage": {
      "type": "string"
    },
    "alwaysEscalateWhenUnsure": {
      "type": "boolean"
    },
    "supportPageEnabled": {
      "type": "boolean"
    },
    "articles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": [
              "integer",
              "null"
            ]
          },
          "productId": {
            "type": [
              "integer",
              "null"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "faq",
              "install",
              "activation",
              "download",
              "compatibility",
              "policy",
              "known_issue",
              "troubleshooting"
            ]
          },
          "title": {
            "type": "string"
          },
          "body": {
            "type": "string"
          },
          "sortOrder": {
            "type": "integer"
          },
          "visible": {
            "type": "boolean"
          },
          "createdAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "updatedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        },
        "additionalProperties": true
      }
    }
  },
  "additionalProperties": true
}

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "settings": {
      "type": "object",
      "properties": {
        "supportEmail": {
          "type": "string"
        },
        "businessAddress": {
          "type": "string"
        },
        "supportPhone": {
          "type": "string"
        },
        "primaryContactName": {
          "type": "string"
        },
        "supportUrlOverride": {
          "type": "string"
        },
        "supportUrlOverrideEnabled": {
          "type": "boolean"
        },
        "supportDisplayName": {
          "type": "string"
        },
        "supportContactLabel": {
          "type": "string"
        },
        "responseTimeMessage": {
          "type": "string"
        },
        "availabilityMessage": {
          "type": "string"
        },
        "contactFormEnabled": {
          "type": "boolean"
        },
        "contactFormDestinationEmail": {
          "type": "string"
        },
        "aiAssistantEnabled": {
          "type": "boolean"
        },
        "aiAssistantTone": {
          "type": "string"
        },
        "escalationMessage": {
          "type": "string"
        },
        "alwaysEscalateWhenUnsure": {
          "type": "boolean"
        },
        "supportPageEnabled": {
          "type": "boolean"
        }
      },
      "additionalProperties": true
    },
    "articles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": [
              "integer",
              "null"
            ]
          },
          "productId": {
            "type": [
              "integer",
              "null"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "faq",
              "install",
              "activation",
              "download",
              "compatibility",
              "policy",
              "known_issue",
              "troubleshooting"
            ]
          },
          "title": {
            "type": "string"
          },
          "body": {
            "type": "string"
          },
          "sortOrder": {
            "type": "integer"
          },
          "visible": {
            "type": "boolean"
          },
          "createdAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "updatedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        },
        "additionalProperties": true
      }
    },
    "requests": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": [
              "integer",
              "null"
            ]
          },
          "developerId": {
            "type": [
              "integer",
              "null"
            ]
          },
          "customerId": {
            "type": [
              "integer",
              "null"
            ]
          },
          "productId": {
            "type": [
              "integer",
              "null"
            ]
          },
          "email": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "issueType": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "context": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          },
          "status": {
            "type": "string",
            "enum": [
              "new",
              "open",
              "waiting",
              "closed"
            ]
          },
          "createdAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "updatedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        },
        "additionalProperties": true
      }
    },
    "legacy": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "resolver": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "source": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

GET /api/developer/support/requests

Read a filtered page of customer support requests

Auth
Account Bearer session token
Scope
customers.view and all-products scope in the selected developer workspace.
Request fields
  • query status: string
  • query limit: integer
  • query offset: integer
Returns
HTTP 200: requests, hasMore, nextOffset, status.
Notes
Newest requests first, ordered by createdAt and ID. Follow hasMore and nextOffset; a page length is not the total inbox count. A positive integer limit above 50 is capped at 50. Request identity, messages and context are private. context.notification can report pending, accepted or failed notification submission; accepted is not proof of inbox arrival. Replies sent through an external email inbox are not tracked as conversation messages.
Request, response and error reference

Query and header parameters

[
  {
    "name": "status",
    "in": "query",
    "schema": {
      "type": "string",
      "enum": [
        "all",
        "new",
        "open",
        "waiting",
        "closed"
      ],
      "default": "all"
    },
    "required": false,
    "description": ""
  },
  {
    "name": "limit",
    "in": "query",
    "schema": {
      "type": "integer",
      "minimum": 1,
      "default": 50,
      "description": "Positive whole number; values above 50 are capped at 50."
    },
    "required": false,
    "description": ""
  },
  {
    "name": "offset",
    "in": "query",
    "schema": {
      "type": "integer",
      "minimum": 0,
      "default": 0
    },
    "required": false,
    "description": ""
  }
]

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "requests": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": [
              "integer",
              "null"
            ]
          },
          "developerId": {
            "type": [
              "integer",
              "null"
            ]
          },
          "customerId": {
            "type": [
              "integer",
              "null"
            ]
          },
          "productId": {
            "type": [
              "integer",
              "null"
            ]
          },
          "email": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "issueType": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "context": {
            "type": "object",
            "additionalProperties": true,
            "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
          },
          "status": {
            "type": "string",
            "enum": [
              "new",
              "open",
              "waiting",
              "closed"
            ]
          },
          "createdAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "updatedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        },
        "additionalProperties": true
      }
    },
    "hasMore": {
      "type": "boolean"
    },
    "nextOffset": {
      "type": "integer"
    },
    "status": {
      "enum": [
        "all",
        "new",
        "open",
        "waiting",
        "closed"
      ]
    }
  },
  "required": [
    "requests",
    "hasMore",
    "nextOffset",
    "status"
  ],
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

Operation errors: INVALID_SUPPORT_STATUS, INVALID_INPUT.

PATCH /api/developer/support/requests/{requestId}

Update one support request status

Auth
Account Bearer session token
Scope
customers.view plus customers.manage and all-products scope; the request must belong to the selected developer workspace.
Request fields
  • status: new | open | waiting | closed (required)
  • updatedAt: string,null
Returns
HTTP 200: request.
Notes
Pass the latest returned updatedAt for optimistic concurrency. A concurrent revision returns 409 SUPPORT_REQUEST_CHANGED; reload and reconcile before retrying. An absent or other-workspace request returns 404 SUPPORT_REQUEST_NOT_FOUND. Omitting updatedAt skips the revision check. This changes status and its audit context; it does not send a reply, retry a failed notification, change customer access or refund a purchase.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "new",
        "open",
        "waiting",
        "closed"
      ]
    },
    "updatedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  },
  "required": [
    "status"
  ],
  "additionalProperties": true
}

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "request": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": [
            "integer",
            "null"
          ]
        },
        "customerId": {
          "type": [
            "integer",
            "null"
          ]
        },
        "productId": {
          "type": [
            "integer",
            "null"
          ]
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "issueType": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "context": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "status": {
          "type": "string",
          "enum": [
            "new",
            "open",
            "waiting",
            "closed"
          ]
        },
        "createdAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    }
  },
  "required": [
    "request"
  ],
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

Operation errors: INVALID_SUPPORT_STATUS, INVALID_INPUT, SUPPORT_REQUEST_CHANGED, SUPPORT_REQUEST_NOT_FOUND.

POST /api/developer/support/ai/support-items

Generate draft FAQ and support content

Auth
Account Bearer session token
Scope
customers.view plus settings.manage and all-products scope.
Request fields
  • productId: integer
  • currentProduct: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
  • notes: string
  • instructions: string
  • referenceUrl: string
  • referenceUrls: array
  • tone: string
Returns
HTTP 200: draftId, toolType, suggestions, provider, model, status, persistenceWarning.
Notes
Uses the product setup AI draft store, not operational drafts. Suggested faqs, supportNote, installSummary, troubleshooting and warnings must be reviewed and saved through the supported content workflow. Does not automatically publish articles, change refund terms or send a reply. Provider configuration and quotas still apply.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "productId": {
      "type": "integer",
      "minimum": 1
    },
    "currentProduct": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "notes": {
      "type": "string"
    },
    "instructions": {
      "type": "string"
    },
    "referenceUrl": {
      "type": "string"
    },
    "referenceUrls": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tone": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "draftId": {
      "anyOf": [
        {
          "anyOf": [
            {
              "type": "integer",
              "minimum": 1
            },
            {
              "type": "string",
              "pattern": "^[1-9][0-9]*$"
            }
          ],
          "description": "A positive identifier. PostgreSQL bigint fields can be decimal strings; preserve them without lossy numeric conversion."
        },
        {
          "type": "null"
        }
      ]
    },
    "toolType": {
      "type": "string"
    },
    "suggestions": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "provider": {
      "type": "string"
    },
    "model": {
      "type": [
        "string",
        "null"
      ]
    },
    "status": {
      "type": "string"
    },
    "persistenceWarning": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 429, 500, 502, 503.

Support routing and notification history

A branded support form routes to the configured private destination; a public reply-to or support address is a separate presentation choice. Owner/admin settings access controls configuration without disabling ordinary customer support permissions.

Recorded notification outcomes and message history distinguish queued, sent, skipped and failed work. A saved request is not proof of inbox delivery. Keep customer addresses, full names, serials and private message content out of public screenshots.

Read and update the request inbox

GET /api/developer/support/requests returns a newest-first page. status accepts all, new, open, waiting or closed; limit defaults to 50 and is capped at 50; offset starts at zero. Follow hasMore and nextOffset instead of treating the number loaded as the total inbox size. Reads require customers.view and all-products workspace scope.

PATCH /api/developer/support/requests/{requestId} additionally requires customers.manage. Send status and the last returned updatedAt to protect against a concurrent change. A 409 SUPPORT_REQUEST_CHANGED means reload and reconcile; a 404 SUPPORT_REQUEST_NOT_FOUND does not reveal another workspace request. Omitting updatedAt skips the revision check.

SoundSync

Read a request page before changing status

Illustrative selected-workspace requests
curl --fail-with-body -sS "$SOUNDSYNC_API_BASE/api/developer/support/requests?status=open&limit=25&offset=0" \
  -H "Authorization: Bearer $DEVELOPER_TOKEN"

curl --fail-with-body -sS -X PATCH "$SOUNDSYNC_API_BASE/api/developer/support/requests/123" \
  -H "Authorization: Bearer $DEVELOPER_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"status":"waiting","updatedAt":"2026-11-20T12:00:00.000Z"}'

# Replace the ID and updatedAt with the values you just read.

A status change is not an email reply

Request context includes notification-submission state. Accepted means the notification was accepted for sending, not confirmed inbox arrival. Updating status does not retry a failed notification or send a customer reply. Keep request names, addresses, messages and context private.

SoundSync

Customer requests stay connected to the support workspace

The current inbox shows status filtering, notification outcome, Reply by email and a separate status update. This is the shipping interface with illustrative requests; names, addresses, messages, IDs and counts are pixel-blurred. No reply was sent or request changed.

Support inbox: filters, notification outcome and request status