Messaging

Retrieve a campaign

Scope: read

get/v1/campaigns/{id}

Request

  • Base URL: https://api.affiliaterail.com
  • URL: https://api.affiliaterail.com/v1/campaigns/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Query parameters

program_idstring required

Response

The campaign

idstring required

Prefixed id (camp_…)

object'campaign' required
program_idstring required

Prefixed id (prg_…)

namestring required
subjectstring required
status'draft' | 'scheduled' | 'sending' | 'paused' | 'sent' required
scheduled_atstring date-time nullable required

ISO-8601, UTC

sent_atstring date-time nullable required

ISO-8601, UTC

created_atstring date-time required

ISO-8601, UTC

updated_atstring date-time required

ISO-8601, UTC

Example response

{
  "id": "camp_7uSyy9FqVLCFWrdPeZaK",
  "program_id": "prg_7uSyy9FqVLCFWrdPeZaK",
  "scheduled_at": "2026-08-21T10:15:30.000Z",
  "sent_at": "2026-08-21T10:15:30.000Z",
  "created_at": "2026-08-21T10:15:30.000Z",
  "updated_at": "2026-08-21T10:15:30.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.