API DocsAPI Docs / Tracker / Shares / Create

Note: If both start_date and end_date are provided, end_date must be after start_date. When both are null, all tracker data is shared without date restrictions.

include_progress_photo is the one flag that defaults to false. Every other type follows "a share covers everything unless the athlete unchecks it". A body photo of an identifiable person is opted into, never opted out of, so a share grants access to progress photos only when this flag is sent as true. A share-editing UI that assumes a uniform default will mis-render it. The flag governs the image as well as the entry: with it off, the media URL of a progress photo returns 403 to that viewer.

include_measurement defaults to true for shares that already existed. The column was added with a true default, so every share created before this feature shipped covers body measurements without its sharer doing anything. Nothing was retroactively disclosed — body measurements are a new record type, so none existed when the column landed — but a sharer who does not want the new type shared turns the flag off with PUT /api/v1/tracker/shares/{id}. A client that lists shares should not assume an existing share's flags are unchanged from when it was made.

notify_* flags are not accepted here. They belong to the viewer, who sets them with PUT /api/v1/tracker/shares/{id}. They are stored as false and this response returns them as null — the freshly-inserted row has not read its column defaults back. Read the share back through GET /api/v1/tracker/shares for their real values.

One share per pair of people. Posting again for a viewer_user_id you already share with updates that share and returns it, rather than creating a second one — so the endpoint is safe to re-submit, and "the share with this person" always names exactly one row. The status is 201 either way, and the viewer is notified only when a share is actually created, not on a re-submit. An omitted include_* flag defaults to true on every call, so a repeat post rewrites the whole grant rather than patching it; the notify_* flags and the dates are left as they were unless you send them. To change one field, use PUT /api/v1/tracker/shares/{id}.

Request Example

Response

201 Created

Returns the created shared tracker resource.

See Shared Tracker Resource.

Error Responses