FOfolk
Campaigns

Get a message of a campaign

Changed on

Retrieve a single message of a campaign.<br/><Warning>This endpoint is currently in open beta. The API surface may change as we iterate based on feedback.</Warning>

get/v1/campaigns/{campaignId}/messages/{messageId}

Request

  • Base URL
    https://api.folk.app
  • URL
    https://api.folk.app/v1/campaigns/{campaignId}/messages/{messageId}
  • Auth
    HTTP bearer

Path parameters

campaignIdstring required

The ID of the campaign.

messageIdstring required

The ID of the message.

Response

The message of the campaign.

deprecationsstring[]

Example response

{
  "data": {
    "id": "msg_1d2c3b4a-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "campaignId": "cmp_9b2f1c1e-2b8a-4d1e-8f5a-3c2d1e0f9a8b",
    "step": 1,
    "recipient": {
      "contact": {
        "id": "per_55175e81-9a52-4ac3-930e-82792c23499b",
        "entityType": "person"
      },
      "name": "John Doe",
      "email": "john.doe@example.com"
    },
    "sender": {
      "id": "snd_4c3b2a19-8f7e-4d6c-9b5a-1e2f3d4c5b6a",
      "email": "john.doe@example.com",
      "displayName": "John Doe"
    },
    "subject": "Quick question, John",
    "body": "<p>Hi John,</p><p>{{signature}}</p>",
    "cc": [],
    "bcc": [],
    "status": "draft",
    "notSentReason": null,
    "unsubscribed": false
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes