Salutation

Salutations for many names in one request

Up to 100 names, one credit each. language, the country hint, gender and min_probability apply to every name. Results come back in the order sent.

post/api/v1/salutation/bulk

Request

  • Base URL: https://namegender.com
  • URL: https://namegender.com/api/v1/salutation/bulk
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Request body

namesstring[] required
type'name' | 'email'

email reads every value as an email address.

languagestring

The language the salutation is written in: en, en-US, en-GB, de, de-AT, de-CH, fr, es, it, pt, pt-PT, pt-BR, nl, tr, pl, ja. When omitted, the language of locale, then the main language of the country, then en. An unsupported language is an error, never a silent fall back to English.

countrystring

Country hint for the gender lookup, as on the gender endpoints. It does not set the language when language is sent: write to Mr Müller in the US in English.

localestring
ipstring
gender'male' | 'female' | 'neutral'

Gender you already know. Overrides the lookup; neutral always gives the neutral form.

min_probabilityinteger

Lowest probability for a gendered salutation. Below it the neutral form is used.

titlestring

Academic title kept in a separate field. Used in German and English salutations.

Example request

{
  "language": "de",
  "title": "Dr."
}

Response

Every name processed, in the order sent.

credits_chargedinteger
credits_remaininginteger
data_versionstring nullable
request_idstring
took_msinteger
country_source'country' | 'locale' | 'ip' | 'null' nullable
languagestring

Example response

{
  "results": [
    {
      "language": "de",
      "salutation": {
        "formal": "Sehr geehrte Frau Dr. Müller,",
        "informal": "Liebe Anna,",
        "neutral": "Guten Tag Dr. Anna Müller,"
      }
    }
  ]
}

Changes

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