Sign in
admin

Patch an API Key

Patch an API Key. Accessible by GO only.

patch/v0/api_keys/{id}

Request

  • Base URL: https://api.clubmed.com
  • URL: https://api.clubmed.com/v0/api_keys/{id}
  • Auth: OpenID Connect (https://auth.clubmed.com/.well-known/openid-configuration, scopes: openid, email, profile, clubmed)

Path parameters

idstring required

Api_key provided by ClubMed API team

Example:878545411597.test.clubmed.com

Headers

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

idstring

Api_key provided by ClubMed API team

profilestring

api_key profile

contactsstring[]

api_key contact emails

localesstring[]

List of allowed locales for this client

clic_channel_codestring

CLIC channel code

channel_codestring

Channel code

application_codestring

Application code

date_offset_enabledboolean

Is the date offset should be considered for the api_key

enabledboolean

Is the api_key enabled

authentication_requiredboolean

Is authentication required

agent_idstring

Agent id

consumerstring

Consumer of the API key, e.g. "B2C", "APP", "CMTA", "B2B"

prebookable_price_accessboolean

If true, this API key will have access to prebookable prices across all API endpoints (no impact on the calendar and bookable_dates endpoints).

quable_channel_codestring nullable

Quable channel code associated with the API key

Example request

{
  "id": "878545411597.test.clubmed.com",
  "profile": "b2c",
  "contacts": [
    "john.smith@gmail.com"
  ],
  "locales": [
    "en-US"
  ],
  "clic_channel_code": "TDB",
  "channel_code": "NET",
  "quable_channel_code": "B2B"
}

Response

ok

idstring

Api_key provided by ClubMed API team

profilestring required

api_key profile

contactsstring[] required

api_key contact emails

localesstring[] required

List of allowed locales for this client

clic_channel_codestring required

CLIC channel code

channel_codestring required

Channel code

application_codestring required

Application code

date_offset_enabledboolean

Is the date offset should be considered for the api_key

enabledboolean required

Is the api_key enabled

authentication_requiredboolean

Is authentication required

agent_idstring

Agent id

consumerstring

Consumer of the API key, e.g. "B2C", "APP", "CMTA", "B2B"

prebookable_price_accessboolean

If true, this API key will have access to prebookable prices across all API endpoints (no impact on the calendar and bookable_dates endpoints).

quable_channel_codestring nullable

Quable channel code associated with the API key

Example response

{
  "id": "878545411597.test.clubmed.com",
  "profile": "b2c",
  "contacts": [
    "john.smith@gmail.com"
  ],
  "locales": [
    "en-US"
  ],
  "clic_channel_code": "TDB",
  "channel_code": "NET",
  "quable_channel_code": "B2B"
}

Changes