customers

Newsletters subscription.

When a customer wants to subscribe to newsletters, they fill in their personal information and specify which newsletters they wish to subscribe to, as well as the communication channel through which they want to be contacted.

Either Gender or Civility must be provided.

post/v1/subscriptions

Request

  • Base URL: https://api.clubmed.com
  • URL: https://api.clubmed.com/v1/subscriptions
  • Auth: HTTP bearer

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
x-api-keystring required

Api_key provided by ClubMed API team

Request body

emailstring nullable

A valid email adress.

gender'M' | 'F' nullable

The customer gender : "M" (Male) or "F" (Female).

civility_codestring nullable

Customer civility, based on the civilities resource.

first_namestring nullable

The customer first name, Ex : Jean

unicode_first_namestring nullable

The customer first name in unicode character, useful in double byte countries like China, Ex : 牛仔裤

last_namestring nullable

The customer last name Ex: Chang

unicode_last_namestring nullable

The customer last name in unicode character, useful in double byte countries like China, Ex : 昌

phonestring nullable

A phone number.

birthdatestring date nullable

The customer date of birth in the YYYYMMDD or YYYY-MM-DD format. Supported formats: YYYYMMDDTHH:mm:ss.SSS[Z], YYYYMMDDTHH:mm:ss.SSS, YYYYMMDD HH:mm:ss.SSS, YYYYMMDDTHH:mm:ss, YYYYMMDD HH:mm:ss, YYYY-MM-DDTHH:mm:ss.SSS, YYYY-MM-DD HH:mm:ss.SSS, YYYY-MM-DD HH:mm:ss, YYYY-MM-DDTHH:mm:ss, YYYY-MM-DDTHH:mm:ss.SSSSSSS, YYYY-MM-DD HH:mm:ss.SSSSSSS, YYYY-MM-DDTHH:mm:ssZ, YYYY-MM-DD HH:mm:ssZ, YYYY-MM-DDTHH:mm:ss.SSSZ, YYYY-MM-DDTHH:mm:ss.SSS[Z], YYYY-MM-DD HH:mm:ss.SSS[Z], YYYY-MM-DD HH:mm:ss[Z]

origin_code'CUSTOMER_ACCOUNT' | 'FILE_INTEGRATION' | 'NEWSLETTER' | 'PARTICIPANT_PAGE' | 'POPIN' | 'WEBNA' nullable

Describe the origin page from which the newsletter was subscribed.

newsletter_subscriptionsstring[] required

The list of newsletters the customer wants to subscribe to. Retrieve the list of available newsletters using GET /v0/newsletters.

Example request

{
  "email": "name@email.com",
  "gender": "M",
  "civility_code": "MR",
  "first_name": "Jean",
  "unicode_first_name": "牛仔裤",
  "last_name": "Chang",
  "unicode_last_name": "昌",
  "phone": "+33145789632",
  "birthdate": "1999-12-20",
  "optins": [
    {
      "channel": "EMAIL",
      "optin": true
    }
  ],
  "origin_code": "CUSTOMER_ACCOUNT",
  "newsletter_subscriptions": [
    "CLUBMED"
  ]
}

Response

Successful

idstring required

A unique id for this subscription ex: "6dcd659809d740bd400db3df298bfece50a4fec3"

customer_idstring

Customer ID (neolid clic)

Example response

{
  "id": "6dcd659809d740bd400db3df298bfece50a4fec3",
  "customer_id": "123456789"
}

Changes

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