Model: Helpline

1 min

Model Parameters

Helpline
- idstringrequired
  Example
  crisis-text-line
  Description
  The unique identifier for the helpline.
- namestringrequired
  Example
  Crisis Text Line
  Description
  Official name of the helpline in the native language.
- descriptionsDescription[]
  Description
  Descriptions of the service provided by the helpline, one entry per language. Empty for Entry-tier applications.
  - languagestringrequired
    Example
    en
    Description
    ISO language code of this description.
  - fullDescriptionstringrequired
    Description
    Full description of the service provided by the helpline. Formatting, if any, will use markdown.
  - shortDescriptionstring
    Description
    Concise summary of the service provided by the helpline. Currently only available for English.
- websitestring<uri>
  Example
  https://www.crisistextline.org/
  Description
  Primary website of the service.
  Format
  uri
- countryobjectrequired
  - Country
    - namestringrequired
      Example
      New Zealand
      Description
      English language name for the country.
    - codestringrequired
      Example
      nz
      Description
      ISO 3166 Alpha-2 code for the country.
    - emergencyNumberstring
      Example
      111
      Description
      Emergency services phone number. Only available for countries where suicide is not a illegal.
- timezonestringrequired
  Example
  America/Los_Angeles
  Description
  The timezone where this helpline operates.
- primaryTopicsstring[]required
  Description
  A collection of topics which the helpline primarily supports.
- secondaryTopicsstring[]required
  Description
  A collection of topics which the helpline secondarily supports.
- supportedLanguagesstring[]required
  Example
```
[
  "en",
  "es",
  "fr"
]
```
  Description
  A collection of ISO language codes that the helpline supports.
- specialtiesstring[]required
  Description
  Specialties categorize services by audience demographics, identity groups, and specific service needs.
- supportTypesstring[]
  Description
  A collection listing the qualification of the people who provide support at the helpline. e.g. Counselors, Volunteers, Peers, etc. Only available for Full tier applications
- interpretationServiceProvidedbooleanrequired
  Description
  Whether the helpline provides interpretation services for people who do not speak any of the supported languages.
- membershipOrganizationsstring[]required
  Description
  A collection of membership organizations that the helpline is affiliated with.
- contactMethodsContactMethod[]required
  Description
  Ways to reach this helpline. Each element carries its own opening hours.
  - typestring<phone | sms | onlineChat | whatsapp | tty | reportingForm>required
    Example
    phone
    Description
    The kind of contact method.
    Allowed
    phonesmsonlineChatwhatsappttyreportingForm
  - valuestringrequired
    Example
    1-800-273-8255
    Description
    The value used to reach the helpline by this contact method (e.g. phone number or chat URL).
  - accessibilityNotesstring
    Description
    Optional notes about the accessibility of this contact method.
  - alwaysOpenbooleanrequired
    Description
    Indicates if this contact method is always available. When true, openingHours will be empty.
  - openingHoursOpeningSpan[]required
    Description
    Opening periods for this contact method with overlapping and adjacent periods merged and resolved to the helpline's timezone. Empty when alwaysOpen is true. null when the application's API tier does not permit access to opening hours.
    - localDayOfWeekstring<monday | tuesday | wednesday | thursday | friday | saturday | sunday>required
      Example
      monday
      Description
      Day of the week this period applies to in the helpline's local timezone.
      Allowed
      mondaytuesdaywednesdaythursdayfridaysaturdaysunday
    - openstring<date-time>required
      Example
      2026-04-13T09:00:00+12:00
      Description
      ISO 8601 datetime of the next occurrence of when the helpline opens, in the helpline's timezone.
      Format
      date-time
    - closestring<date-time>required
      Example
      2026-04-13T17:00:00+12:00
      Description
      ISO 8601 datetime of the next occurrence of when the helpline closes, in the helpline's timezone.
      Format
      date-time

Helpline model