API

Help center (customer portal)

Raise, follow, reply to and rate service requests as a customer.

See Tasks.

Every route below, with its parameters, request and response, errors and samples, is in the API reference.

RouteWhat it does
GET /v1/portal/issues/:orgHelp centers in an organization the caller can use.
GET /v1/portal/issues/:org/:spaceKeyA help center: title, intro and request types.
GET /v1/portal/issues/:org/:spaceKey/requestsThe caller's requests (reported or participating): status open, closed or all.
POST /v1/portal/issues/:org/:spaceKey/requestsRaises a request.
GET /v1/portal/issues/:org/:spaceKey/requests/:issueKeyOne of the caller's requests with its public conversation.
POST /v1/portal/issues/:org/:spaceKey/requests/:issueKey/commentsReplies on a request.
POST /v1/portal/issues/:org/:spaceKey/requests/:issueKey/attachmentsStarts a file upload on a request: a presigned PUT, then …/complete.
POST /v1/portal/issues/:org/:spaceKey/requests/:issueKey/attachments/:attachmentId/completeConfirms an upload once the file is in place; it then shows on the request.
GET /v1/portal/issues/:org/:spaceKey/requests/:issueKey/attachments/:attachmentIdA short-lived download link for a file on the request.
POST /v1/portal/issues/:org/:spaceKey/requests/:issueKey/participantsShares a request with someone by email.
DELETE /v1/portal/issues/:org/:spaceKey/requests/:issueKey/participants/:whoStops sharing a request with someone (an account id or an address).
GET /v1/portal/issues/:org/:spaceKey/articlesHelp articles (Knowledge pages under the help center's root) matching q, for suggestions.
GET /v1/portal/issues/:org/:spaceKey/articles/:pageIdOne help article (Markdown).
POST /v1/portal/issues/:org/:spaceKey/requests/:issueKey/ratingRates a resolved request, 1–5, once.