Status Page Subscriber
Create Status Page Subscriber
Endpoint to create a new Status Page Subscriber
post/status-page-subscriber
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScripthttps://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/docs/status-page-subscriber/post.tsA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"data": {
"projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"statusPageId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
}Response
Created successfully
Example response
{
"data": {
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"createdAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"updatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"deletedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"project": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"statusPage": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"statusPageId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"subscriberEmail": "user@example.com",
"subscriberPhone": "+1-555-0123",
"subscriberWebhook": "https://example.com",
"slackWorkspaceName": "Example Text",
"microsoftTeamsWorkspaceName": "This is an example of longer text content that provides detailed information.",
"language": "Example Text",
"createdByUser": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"deletedByUser": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"isSubscriptionConfirmed": true,
"isUnsubscribed": true,
"unsubscribedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"isAddedByTeam": true,
"sendYouHaveSubscribedMessage": true,
"isSubscribedToAllResources": true,
"isSubscribedToAllEventTypes": true,
"statusPageResources": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"statusPageEventTypes": {
"key": "value",
"nested": {
"data": 123
}
},
"internalNote": null
}
}Changes
No recorded changes to this operation across all 1 revision of this API.