Endpoints to manage campaigns via the REST API.
5 endpoints tagged campaigns, each listing its
parameters and possible responses. Search or scroll the index below to
jump to a specific endpoint.
No endpoints match your search.
GET /orgs/{org}/campaigns
Lists campaigns in an organization.
| Name | In | Required | Description |
|---|---|---|---|
org | path | yes | The organization name. The name is not case sensitive. |
page | query | no | The page number of the results to fetch. For more information, see "Using pagination in the REST API." |
per_page | query | no | The number of results per page (max 100). For more information, see "Using pagination in the REST API." |
direction | query | no | The direction to sort the results by. |
state | query | no | If specified, only campaigns with this state will be returned. |
sort | query | no | The property by which to sort the results. |
| Status | Description | Has JSON body |
|---|---|---|
| 200 | Response | yes |
| 404 | Resource not found | yes |
| 503 | Service unavailable | yes |
POST /orgs/{org}/campaigns
Create a campaign for an organization.
| Name | In | Required | Description |
|---|---|---|---|
org | path | yes | The organization name. The name is not case sensitive. |
| Status | Description | Has JSON body |
|---|---|---|
| 200 | Response | yes |
| 400 | Bad Request | yes |
| 404 | Resource not found | yes |
| 422 | Unprocessable Entity | yes |
| 429 | Too Many Requests | no |
| 503 | Service unavailable | yes |
GET /orgs/{org}/campaigns/{campaign_number}
Gets a campaign for an organization.
| Name | In | Required | Description |
|---|---|---|---|
org | path | yes | The organization name. The name is not case sensitive. |
campaign_number | path | yes | The campaign number. |
| Status | Description | Has JSON body |
|---|---|---|
| 200 | Response | yes |
| 404 | Resource not found | yes |
| 422 | Unprocessable Entity | yes |
| 503 | Service unavailable | yes |
PATCH /orgs/{org}/campaigns/{campaign_number}
Updates a campaign in an organization.
| Name | In | Required | Description |
|---|---|---|---|
org | path | yes | The organization name. The name is not case sensitive. |
campaign_number | path | yes | The campaign number. |
| Status | Description | Has JSON body |
|---|---|---|
| 200 | Response | yes |
| 400 | Bad Request | yes |
| 404 | Resource not found | yes |
| 422 | Unprocessable Entity | yes |
| 503 | Service unavailable | yes |
DELETE /orgs/{org}/campaigns/{campaign_number}
Deletes a campaign in an organization.
| Name | In | Required | Description |
|---|---|---|---|
org | path | yes | The organization name. The name is not case sensitive. |
campaign_number | path | yes | The campaign number. |
| Status | Description | Has JSON body |
|---|---|---|
| 204 | Deletion successful | no |
| 404 | Resource not found | yes |
| 503 | Service unavailable | yes |