support

Contact customer service

Submit a support message. Creates a support ticket and emails the tenant's support inbox; the returned ticket_id resolves at GET /tickets/{id}.

post/support/contact

Request

  • Base URL: https://api.instruxi.dev/api/v1/enforcer
  • URL: https://api.instruxi.dev/api/v1/enforcer/support/contact
  • Auth: one of:
    • API key in header Authorization
    • API key in header X-API-Key

Request body

bodystring
source'automated'

Source is an OPTIONAL stamp for program-filed tickets: "automated" marks the ticket as filed by code (the PWA's Plaid auto-ticket), so the support queue can hide it server-side (GET /tickets?source=support_contact) instead of guessing from the subject. Omitted = support_contact (a person). Any other value is a 400.

subjectstring

Example request

{
  "body": "I need help with my account.",
  "source": "automated",
  "subject": "Support Request"
}

Response

OK

successboolean
ticket_idstring

Example response

{
  "success": true,
  "ticket_id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301"
}

Changes

No recorded changes to this operation across all 1 revision of this API.