POpolar-com
Users

Register user

Changed on

Once partner has been authorized by user, partner must register the user before being able to access its data. API user-id and Polar User Id (polar-user-id) are interchangeable terms.

post/v3/users

Request

Request body

member-idstring required

Partner's custom identifier for user.

Example request

{
  "member-id": "User_id_999"
}

Response

User's base information.

polar-user-idinteger

User's id in Polar database

member-idstring

User's identifier in partner's database

registration-datestring date-time

Timestamp marked when ACCEPTED

first-namestring

User's first name

last-namestring

User's surname

birthdatestring

User's birthdate as YYYY-MM-DD

gender'MALE' | 'FEMALE'

User's sex

weightnumber float

User's weight in kg

heightnumber float

Users height in centimeters

Example response

{
  "polar-user-id": 2278512,
  "member-id": "i09u9ujj",
  "registration-date": "2011-10-14T12:50:37.000Z",
  "first-name": "Eka",
  "last-name": "Toka",
  "birthdate": "1985-09-06",
  "gender": "MALE",
  "weight": 66,
  "height": 170,
  "extra-info": [
    {
      "value": "2",
      "name": "number-of-children"
    }
  ]
}

Changes

  • 5ef2cea678a2Revision changes
    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: application/xml)

  • 425d64c3dd59Revision changes
    • info

      added the non-success response with the status