Sign in

v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
Workout

Update Workout

Update a Workout.

put/workouts/{workout_id}

Path parameters

workout_idinteger required

workout identifier.

Headers

x-api-keystring required

A valid API key. If you don't have one, please request one through the Web Integrations screen.

Request body

datestring date

Date of the Workout

namestring

Name of the Workout. If no value is provided, the Workout name will be Program name and Date.

notesstring

Notes for the Workout

is_workout_visible_to_all_athletesstring

Defaults to the Programs secure programming setting. Can only be changed from the default value of the program if Membership Enforcement is enabled.

should_publish_to_blogstring

Indicates if the Workout should be published externally. Only applicable if a Wordpress site is already linked, or an API is already set up.

internal_publish_timestring

Time the Workout should be published in Wodify. If no value is provided, will use the current date time.

internal_publish_datestring date

Date the Workout should be published in Wodify. If no value is provided, will use the current date time.

blog_publish_datestring date

Date the Workout should be published in to external blogs. Only applicable if IsPublishExternally is true. If publishing externally and no datetime is provided, the current datetime will be used.

blog_publish_timestring

Time the Workout should be published in to external blogs. Only applicable if IsPublishExternally is true. If publishing externally and no datetime is provided, the current datetime will be used.

Example request

{
  "date": "2014-12-31",
  "internal_publish_date": "2014-12-31",
  "blog_publish_date": "2014-12-31"
}

Response

Data for the created workout

idinteger required

WOD (Header) ID

namestring

Workout Name

datestring date

Date the Workout applies to

internal_publish_datestring date

Date the Workout should be published in Wodify. If no value is provided, will use the current date time.

internal_publish_timestring time

Time the Workout should be published in Wodify. If no value is provided, will use the current date time.

should_publish_to_blogboolean

Previously 'ShouldPublish'

blog_publish_datestring date

Date the Workout should be published in to external blogs. Only applicable if IsPublishExternally is true. If publishing externally and no datetime is provided, the current datetime will be used.

blog_publish_timestring time

Time the Workout should be published in to external blogs. Only applicable if IsPublishExternally is true. If publishing externally and no datetime is provided, the current datetime will be used.

commentstring

WODHeader's Comments

linkified_commentstring

Linkified WODHeader Comments

ownership_level_idinteger

Identifies the Ownership Level of the WOD Header record

ownership_levelstring

Ownership Level of the WOD Header record

program_idinteger

Program Id

programstring

Program name

copied_from_workout_idinteger

Identifies the Workout record this record was copied from, if this record was copied from another Workout

copied_from_workoutstring

name the Workout record this record was copied from, if this record was copied from another Workout

secure_programming_enabledboolean

Flag to control whether or not 'secure programming' is enabled for the WOD or not (default value = false).

notesstring

notes

tagsstring[]

Tags

wodify_validation_resultstring

The purpose of this attribute is to save any UserException message, that is, and user friendly message that should be shown to the end user.

Example response

{
  "date": "2014-12-31",
  "internal_publish_date": "2014-12-31",
  "internal_publish_time": "23:59:59",
  "blog_publish_date": "2014-12-31",
  "blog_publish_time": "23:59:59",
  "ownership_level_id": 1234567891234567,
  "program_id": 1234567891234567,
  "copied_from_workout_id": 1234567891234567,
  "created": {
    "created_by_id": 1234567891234567,
    "created_on_datetime": "2014-12-31T23:59:59.938Z"
  },
  "updated": {
    "updated_by_id": 1234567891234567,
    "updated_on_datetime": "2014-12-31T23:59:59.938Z"
  },
  "locations": [
    {
      "location_id": 1234567891234567
    }
  ],
  "workout_components": [
    {
      "id": 1234567891234567,
      "component_id": 1234567891234567,
      "component_type_id": 1234567891234567,
      "uom_weight_id": 1234567891234567,
      "uom_distance_id": 1234567891234567,
      "file_storage_id": 1234567891234567,
      "section_id": 1234567891234567,
      "image_id": 1234567891234567,
      "created": {
        "created_by_id": 1234567891234567,
        "created_on_datetime": "2014-12-31T23:59:59.938Z"
      },
      "updated": {
        "updated_by_id": 1234567891234567,
        "updated_on_datetime": "2014-12-31T23:59:59.938Z"
      },
      "videos": [
        {
          "id": 1234567891234567,
          "file_storage_id": 1234567891234567,
          "created": {
            "created_by_id": 1234567891234567,
            "created_on_datetime": "2014-12-31T23:59:59.938Z"
          },
          "updated": {
            "updated_by_id": 1234567891234567,
            "updated_on_datetime": "2014-12-31T23:59:59.938Z"
          }
        }
      ],
      "images": [
        {
          "id": 1234567891234567,
          "file_storage_id": 1234567891234567,
          "created": {
            "created_by_id": 1234567891234567,
            "created_on_datetime": "2014-12-31T23:59:59.938Z"
          },
          "updated": {
            "updated_by_id": 1234567891234567,
            "updated_on_datetime": "2014-12-31T23:59:59.938Z"
          }
        }
      ]
    }
  ]
}