customers

Update a customer profile.

This resource modifies detailed information of a given account. Fields are optional, simply update the ones you need. Missing or undefined keys will be left ignored. Null and empty strings will be set as null. Any other value will be set as provided.

patch/v1/customers/{customer_id}/profile

Request

  • Base URL: https://api.clubmed.com
  • URL: https://api.clubmed.com/v1/customers/{customer_id}/profile
  • Auth: one of:
    • OpenID Connect (https://auth.clubmed.com/.well-known/openid-configuration, scopes: openid, email, profile, clubmed)
    • OpenID Connect (https://accounts.clubmed.com/.well-known/openid-configuration, scopes: openid, email, profile, clubmed)

Path parameters

customer_idstring required

Customer ID (neolid clic)

Example:123456789

Query parameters

force_addressboolean

Allows you to force an unknown address in the database

Headers

accept-language'fr-FR' | 'fr-BE' | 'nl-BE' | 'de-CH' | 'fr-CH' | 'en-CH' | 'nl-NL' | 'de-DE' | 'en-IL' | 'he-IL' | 'it-IT' | 'en-SE' | 'pt-PT' | 'en-ZA' | 'es-ES' | 'en-GB' | 'en-CY' | 'tr-TR' | 'ru-RU' | 'uk-UA' | 'en-DK' | 'en-FI' | 'en-NO' | 'en-IE' | 'en-US' | 'es-MX' | 'fr-CA' | 'en-CA' | 'es-PA' | 'es-AR' | 'es-CL' | 'pt-BR' | 'es-CO' | 'es-PE' | 'es-VE' | 'es-UY' | 'en-CN' | 'zh-CN' | 'zh-TW' | 'en-TW' | 'en-HK' | 'zh-HK' | 'en-AU' | 'en-ID' | 'id-ID' | 'en-IN' | 'ja-JP' | 'ko-KR' | 'en-MY' | 'en-NZ' | 'en-SG' | 'en-TH' | 'vn-VN' | 'de-AT' | 'ro-RO' | 'pl-PL' | 'et-EE' | 'lv-LV' | 'en-LB' | 'fr-MA' | 'se-SE' | 'th-TH' | 'en-JP' | 'en-AF' | 'en-AL' | 'fr-DZ' | 'fr-AD' | 'en-AO' | 'en-AG' | 'en-SA' | 'en-AM' | 'en-BS' | 'en-BH' | 'en-BD' | 'en-BB' | 'en-BZ' | 'en-BJ' | 'en-BM' | 'en-BT' | 'en-MM' | 'es-BO' | 'es-BW' | 'en-BN' | 'en-BG' | 'en-BI' | 'en-BF' | 'en-CM' | 'fr-CV' | 'en-KY' | 'fr-CF' | 'en-SH' | 'en-CO' | 'en-KM' | 'fr-CG' | 'en-KR' | 'en-KP' | 'en-CR' | 'fr-CI' | 'en-CU' | 'en-DJ' | 'en-DO' | 'en-DM' | 'en-EG' | 'en-SV' | 'en-AE' | 'en-EC' | 'fr-ET' | 'en-FJ' | 'en-GA' | 'en-GM' | 'en-GH' | 'en-GI' | 'gr-GR' | 'en-GD' | 'en-GT' | 'en-GN' | 'fr-GW' | 'en-GQ' | 'en-GY' | 'fr-GP' | 'fr-GF' | 'en-HT' | 'en-HN' | 'en-HU' | 'fr-IQ' | 'en-IR' | 'en-IS' | 'fr-TL' | 'en-JM' | 'en-JO' | 'en-KZ' | 'en-KH' | 'en-KE' | 'fr-KI' | 'en-KW' | 'en-LA' | 'fr-LS' | 'en-LR' | 'en-LY' | 'en-LI' | 'fr-LU' | 'en-MO' | 'en-MG' | 'en-MW' | 'en-MV' | 'en-ML' | 'en-MT' | 'ma-MA' | 'en-MU' | 'en-MR' | 'en-YT' | 'fr-MC' | 'en-MN' | 'fr-MQ' | 'en-MZ' | 'en-MD' | 'fr-PS' | 'en-NA' | 'fr-NR' | 'en-NP' | 'en-NI' | 'en-NE' | 'en-NG' | 'en-NC' | 'fr-CK' | 'en-OM' | 'en-UG' | 'en-PK' | 'en-PA' | 'en-PG' | 'es-PY' | 'en-PH' | 'fr-PN' | 'fr-PF' | 'en-PR' | 'en-QA' | 'en-RW' | 'fr-RE' | 'fr-BL' | 'en-KN' | 'en-MF' | 'en-LC' | 'en-SM' | 'fr-PM' | 'fr-VC' | 'fr-SB' | 'en-WS' | 'fr-ST' | 'en-SN' | 'en-SC' | 'fr-SL' | 'fr-SO' | 'fr-SD' | 'en-LK' | 'en-SR' | 'en-SZ' | 'en-SY' | 'en-TZ' | 'en-TD' | 'en-CZ' | 'fr-IO' | 'fr-TF' | 'en-TG' | 'fr-TO' | 'en-TT' | 'tu-TN' | 'en-TC' | 'fr-TV' | 'fr-LB' | 'en-VU' | 'fr-VA' | 'en-VG' | 'en-VN' | 'en-WF' | 'en-YE' | 'fr-YE' | 'en-RS' | 'fr-CD' | 'fr-ZM' | 'en-ZW' | 'fr-ME' | 'fr-FM' | 'fr-MH' | 'fr-PW' | 'en-HR' | 'en-SI' | 'en-SK' | 'en-EE' | 'en-LT' | 'en-LV' | 'en-MK' | 'en-BA' | 'en-UZ' | 'en-BY' | 'fr-TJ' | 'en-GE' | 'en-AZ' | 'es-DO' | 'fr-TM' | 'fr-TN' | 'sk-SK' required

Language/Country, as returned by <code>GET /v0/locales</code> ; e.g. "en-US", "fr-FR", "ja-JP"

Example:fr-FR
authorizationstring required

Optional Access Token (bearer)

Example:Bearer aaaa.vbbbB.bbbb

Access Token (bearer)

x-api-keystring required

Api_key provided by ClubMed API team

Request body

emailstring nullable

email

civilitystring

civility

unicode_civilitystring

civility (unicode version)

first_namestring

first name

unicode_first_namestring

first name (unicode version)

second_namestring

second name

unicode_second_namestring

second name (unicode version)

third_namestring

third name

unicode_third_namestring

third name (unicode version)

fourth_namestring

fourth name

unicode_fourth_namestring

fourth name (unicode version)

last_namestring

last name

unicode_last_namestring

last name (unicode version)

birthdatestring nullable

date of birth

birth_country_codestring nullable

ISO 2 country code

birth_citystring

customer birth city

language_codestring

customer language. ISO 2 code

personal_data_usage_allowedboolean

true if the customer allows the use of its personal data by Club Med

Example request

{
  "email": "tom@example.com",
  "civility": "MR",
  "unicode_civility": "MR",
  "first_name": "Tom",
  "unicode_first_name": "Tom",
  "second_name": "Charles",
  "unicode_second_name": "Charles",
  "third_name": "Richard",
  "unicode_third_name": "Richard",
  "fourth_name": "Paul",
  "unicode_fourth_name": "Paul",
  "last_name": "Smith",
  "unicode_last_name": "Smith",
  "birthdate": "19870625",
  "birth_country_code": "FR",
  "birth_city": "Paris",
  "phones": [
    {
      "number": "0623456789",
      "type": "MOBILE"
    }
  ],
  "address": {
    "number": "15",
    "street": "AVENUE DES CHAMPS ELYSEES",
    "add_on": "6A",
    "town": "Luynes",
    "city": "Aix-en-Provence",
    "zip_code": "75000",
    "state_or_district": "CA",
    "country": "FRANCE",
    "additional_information_1": "Chez M. Dupont",
    "additional_information_2": "Entreprise Clubmed",
    "country_code": "FR"
  },
  "optins": [
    {
      "channel": "EMAIL",
      "optin": true,
      "optin_partners": true
    }
  ],
  "language_code": "FR",
  "personal_data_usage_allowed": true,
  "identity": {
    "number": "E001241",
    "type": "TAX_NUMBER"
  }
}

Response

no_content

Changes

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