Skip to content

Update User Metadata Collection

Request

Updates the user's metadata collection corresponding to collectionName. Each metadata collection is an unbounded JSON object with client-defined fields.

Security
sessionToken
Path
userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

Tidepool User ID

collectionNamestring(Metadata Collection Name)required

Metadata Collection Name

Enum:"profile""preferences""settings""groups""private"
Example:profile
Bodyapplication/json
Any of:

Profiles used by Tidepool Web

Any of:

User profile used by Tidepool Web

fullNamestring(Full Name)
Example:"James Jellyfish"
patientobject
curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/metadata.v1/metadata/{userId}/profile' \
  -H 'Content-Type: application/json' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE' \
  -d '{
    "fullName": "James Jellyfish",
    "patient": {
      "diagnosisType": "type1",
      "diagnosisDate": "2013-05-09",
      "birthday": "2012-08-30",
      "biologicalSex": "male",
      "targetDevices": [
        "bayercontournext"
      ],
      "targetTimezone": "US/Eastern",
      "about": "Jellyman is awesome!"
    }
  }'

Responses

Success

Bodyapplication/json
Any of:

Profiles used by Tidepool Web

Any of:

User profile used by Tidepool Web

fullNamestring(Full Name)
Example:"James Jellyfish"
patientobject
Response
{ "fullName": "James Jellyfish", "patient": { "diagnosisType": "type1", "diagnosisDate": "2013-05-09", "birthday": "2012-08-30", "biologicalSex": "male", "targetDevices": [ … ], "targetTimezone": "US/Eastern", "about": "Jellyman is awesome!" } }