SCscanopy
Organizations
internal

Submit referral source (how did you hear about us)

Changed on
post/api/v1/organizations/referral-source

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/organizations/referral-source
  • Auth
    none declared

Request body

referral_source'search_engine' | 'ai_assistant' | 'youtube' | 'tiktok' | 'blog_article' | 'reddit' | 'hacker_news' | 'social_media' | 'word_of_mouth' | 'proxmox_community_scripts' | 'self_hosted' | 'other' | 'prefer_not_to_say' required

How a user first heard about Scanopy, as offered by the onboarding prompt.

referral_source_otherstring nullable

Free-text detail, sent when referral_source is other.

Response

Referral source recorded

dataTupleUnit

No payload. Present only so the envelope keeps its shape.

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes

  • c9d9d46d1ae8Revision changes
    • info

      api tag internal added

  • 51af15be596eRevision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      the //// response's property type changed from no type to object for status

    • info

      added the new ai_assistant enum value to the request property

    • info

      added the new blog_article enum value to the request property

    • info

      added the new hacker_news enum value to the request property

    • info

      added the new other enum value to the request property

    • info

      added the new prefer_not_to_say enum value to the request property

    • info

      added the new proxmox_community_scripts enum value to the request property

    • info

      added the new reddit enum value to the request property

    • info

      added the new search_engine enum value to the request property

    • info

      added the new self_hosted enum value to the request property

    • info

      added the new social_media enum value to the request property

    • info

      added the new tiktok enum value to the request property

    • info

      added the new word_of_mouth enum value to the request property

    • info

      added the new youtube enum value to the request property