Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.
Launch Policies
GET /launchPolicies/{organizationId}
Description
Retrieve all launchPolicies for an organization.
View all the Scheduled and Recurring Notifications for the organization.
Return type
collection of launchPolicies
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
credentials | string | y | Basic Authorization header. |
organizationId | long | y | The ID of the organization containing the launchPolicies. |
pageNumber | int | y | The page number of launchPolicies to return. |
GET /launchPolicies/{organizationId}
Description
Retrieve all launchPolicies for an organization.
View all the Scheduled and Recurring Notifications for the organization.
Return type
collection of launchPolicies
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
credentials | string | y | Basic Authorization header. |
organizationId | long | y | The ID of the organization containing the launchPolicies. |
pageNumber | int | y | The page number of launchPolicies to return. |
GET /launchPolicies/{organizationId}/{launchPolicyId}
Description
Retrieve a specific launchPolicy within an organization.
Retrieve the specific Scheduled or Recurring Notification.
Return type
launchPolicy instance
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
credentials | string | y | Basic Authorization header. |
organizationId | long | y | The ID of the organization containing the launchPolicy. |
launchPolicyId | long | y | The ID of the launchPolicy to return. |
POST /launchPolicies/{organizationId}
Description
Create a launchPolicy.
Create a Scheduled or Recurring Notification.
Return type
launchPolicy instance
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
credentials | string | y | Basic Authorization header. |
organizationId | long | y | The ID of the organization from which to initiate the launchPolicy. |
launchPolicy | launchPolicyWrapper | y | The launchPolicy object to create. |
PUT /launchPolicies/{organizationId}/{launchPolicyId}
Description
Update a launchPolicy.
Update a Scheduled or Recurring Notification.
Return type
launchPolicy instance
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
credentials | string | y | Basic Authorization header. |
organizationId | long | y | The ID of the organization from which to initiate the launchPolicy. |
launchPolicyId | long | y | The ID of the launchPolicy to modify. |
launchPolicy | launchPolicyWrapper | y | The new state of the launchPolicy object. |
DELETE /launchPolicies/{organizationId}/{launchPolicyId}
Description
Delete the specified launchPolicy from the organization.
Delete the specified Scheduled or Recurring Notification.
Return type
launchPolicy instance
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
credentials | string | y | Basic Authorization header. |
organizationId | long | y | The ID of the organization containing the launchPolicies. |
launchPolicyId | long | y | The ID of the launchPolicy to delete. |