CLclubplatform
Custom Field

Custom Field

Updates a Custom Field.

put/clubs/{club_id}/custom_fields/{id}

Request

  • Base URL
    https://api.clubplatform.de/api
  • URL
    https://api.clubplatform.de/api/clubs/{club_id}/custom_fields/{id}
  • Auth
    API key in query parameter auth_token

Path parameters

club_idinteger required

ID of the club.

idinteger required

ID of the custom field.

Request body

Example request

{
  "custom_field": {
    "key": "de_activities_fanshop_url",
    "value": "https://shop.bvb.de/",
    "description": "URL to german fanshop. Used on activities stream in mobile apps.",
    "category": "Custom Category"
  }
}

Response

OK

idinteger

Unique internal id.

keystring

Unique identifier.

valuestring

Content of the key.

categorystring

Category for custom field.

descriptionstring

Description which explain how this key/value should be used.

json_formatboolean

indicates if value should be a json. if true the field value is validated to be json

Example response

{
  "id": 1,
  "key": "de_activities_fanshop_url",
  "value": "https://shop.bvb.de/",
  "category": "Custom Category",
  "description": "URL to german fanshop. Used on activities stream in mobile apps."
}

Changes

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