Get Campaign By Id¶
GET /rest/v1/campaigns/{campaignId}.json
Method: GET
Path: /rest/v1/campaigns/{campaignId}.json
Tag: Campaigns
Operation ID: getCampaignByIdUsingGET
Returns the record of a campaign by its id. Required Permissions: Read-Only Campaigns, Read-Write Campaigns
Note: This endpoint has been superseded. Use Get Smart Campaign by Id endpoint instead.
Formats¶
- Request:
application/json - Response:
application/json
Request¶
Path parameters¶
| Name | Type | Required | Description | Constraints |
|---|---|---|---|---|
campaignId |
integer (int32) | Yes | campaignId |
Example request¶
Responses¶
200 — OK¶
Schema: model: ResponseOfCampaign
Generated example¶
{
"errors": [
{
"code": "string",
"message": "string"
}
],
"nextPageToken": "example-token",
"requestId": "123",
"result": [
{
"active": false,
"createdAt": "string",
"description": "string",
"id": 123,
"name": "Example name",
"programId": 123,
"programName": "Example name",
"type": "batch",
"updatedAt": "string",
"workspaceName": "Example name"
}
],
"success": false,
"warnings": [
{
"code": 123,
"message": "string"
}
]
}
Referenced models¶
Source¶
Generated from swagger-mapi.json.
Generated examples are inferred from the schema. They are illustrative and may not be valid production payloads.