Skip to content

Add scheduled unpublish date to Experience REST API #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
anton-ko wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add scheduled unpublish date to Experience REST API #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3490130
This worktree contains only docs (the `api` repo here is a docs-only …
anton-ko Aug 31, 2026
a589b82
Trim the scheduled publishing prose from the API docs
anton-ko Sep 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions mintlify-docs/apis/embeddables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ With the Chameleon API for Embeddables, you can:
| `position` | number | The order that these appear in lists (starting from 0) |
| `segment_ids` | array<ID> | The Chameleon IDs of the configured [Segments](/apis/segments#schema) |
| `published_at` | timestamp | The time this was most recently published |
| `scheduled_publish_at` | timestamp | The time this is scheduled to be published (cleared once it publishes); `null` when no publish is scheduled |
| `scheduled_unpublish_at` | timestamp | The time this is scheduled to stop running (cleared once it unpublishes); `null` when no unpublish is scheduled |
| `tag_ids` | array<ID> | The Chameleon IDs of the [Tags](/apis/tags) attached to this model |
| `rate_unlimit_at` | timestamp | This item is excluded from [Rate limiting](https://help.chameleon.io/en/articles/3513345-rate-limiting-experiences) |
| `dashboard_url` | string | Direct link to this Embeddable in the Chameleon Dashboard |
Expand Down Expand Up @@ -78,6 +80,8 @@ https://api.chameleon.io/v3/edit/embeds
"style": "banner",
"position": 1,
"published_at": "2029-04-07T12:18:00Z",
"scheduled_publish_at": null,
"scheduled_unpublish_at": "2029-05-01T09:00:00Z",
...
},
{
Expand All @@ -86,6 +90,8 @@ https://api.chameleon.io/v3/edit/embeds
"style": "card",
"position": 0,
"published_at": "2029-04-07T12:38:00Z",
"scheduled_publish_at": null,
"scheduled_unpublish_at": null,
...
},
...
Expand Down Expand Up @@ -121,6 +127,8 @@ https://api.chameleon.io/v3/edit/embeds/:id
"style": "banner",
"position": 0,
"published_at": "2029-04-07T12:38:00Z",
"scheduled_publish_at": null,
"scheduled_unpublish_at": null,
...
}
}
Expand Down
8 changes: 8 additions & 0 deletions mintlify-docs/apis/surveys.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ With the Chameleon Microsurveys API, you can:
| `position` | number | The order that these appear in lists (starting from 0) |
| `segment_ids` | array<ID> | The Chameleon IDs of the configured [Segments](/apis/segments#schema) |
| `published_at` | timestamp | The time this was most recently published |
| `scheduled_publish_at` | timestamp | The time this is scheduled to be published (cleared once it publishes); `null` when no publish is scheduled |
| `scheduled_unpublish_at` | timestamp | The time this is scheduled to stop running (cleared once it unpublishes); `null` when no unpublish is scheduled |
| `tag_ids` | array<ID> | The Chameleon IDs of the [Tags](/apis/tags) attached to this model |
| `rate_unlimit_at` | timestamp | This item is excluded from [Rate limiting](https://help.chameleon.io/en/articles/3513345-rate-limiting-experiences) |
| `dashboard_url` | string | Direct link to this Microsurvey in the Chameleon Dashboard |
Expand Down Expand Up @@ -73,13 +75,17 @@ https://api.chameleon.io/v3/edit/surveys
"name": "Task #2 completion CES",
"position": 1,
"published_at": "2029-04-07T12:18:00Z",
"scheduled_publish_at": null,
"scheduled_unpublish_at": "2029-05-01T09:00:00Z",
...
},
{
"id": "5f3c4232c712de665632a2a3",
"name": "Admin account setup #1 completion question",
"position": 0,
"published_at": "2029-04-07T12:38:00Z",
"scheduled_publish_at": null,
"scheduled_unpublish_at": null,
...
},
...
Expand Down Expand Up @@ -159,6 +165,8 @@ https://api.chameleon.io/v3/edit/surveys/:id
"name": "Admin Self-serve menu",
"position": 0,
"published_at": "2029-04-07T12:38:00Z",
"scheduled_publish_at": null,
"scheduled_unpublish_at": null,
...
}
}
Expand Down
8 changes: 8 additions & 0 deletions mintlify-docs/apis/tours.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ With the Chameleon API for Tours, you can:
| `experiment_range` | string | The range of `Profile#percent` that will be included in the experiment |
| `segment_ids` | array<ID> | The Chameleon IDs of the configured [Segments](/apis/segments#schema) |
| `published_at` | timestamp | The time this was most recently published |
| `scheduled_publish_at` | timestamp | The time this is scheduled to be published (cleared once it publishes); `null` when no publish is scheduled |
| `scheduled_unpublish_at` | timestamp | The time this is scheduled to stop running (cleared once it unpublishes); `null` when no unpublish is scheduled |
| `tag_ids` | array<ID> | The Chameleon IDs of the [Tags](/apis/tags) attached to this model |
| `rate_unlimit_at` | timestamp | This item is excluded from [Rate limiting](https://help.chameleon.io/en/articles/3513345-rate-limiting-experiences) |
| `dashboard_url` | string | Direct link to this Tour in the Chameleon Dashboard |
Expand Down Expand Up @@ -79,6 +81,8 @@ https://api.chameleon.io/v3/edit/tours
"style": "auto",
"position": 4,
"published_at": "2029-04-07T12:18:00Z",
"scheduled_publish_at": null,
"scheduled_unpublish_at": "2029-05-01T09:00:00Z",
...
},
{
Expand All @@ -87,6 +91,8 @@ https://api.chameleon.io/v3/edit/tours
"style": "auto",
"position": 3,
"published_at": "2029-04-07T12:18:00Z",
"scheduled_publish_at": null,
"scheduled_unpublish_at": null,
...
},
...
Expand Down Expand Up @@ -176,6 +182,8 @@ https://api.chameleon.io/v3/edit/tours/:id
"style": "auto",
"position": 3,
"published_at": "2029-04-07T12:18:00Z",
"scheduled_publish_at": null,
"scheduled_unpublish_at": null,
...
}
}
Expand Down