FOfolk
Campaigns

List the variables of a campaign

Changed on

Retrieve a paginated list of the {{variables}} a campaign's subjects and bodies can use: the fields of its people or companies, the text and numeric custom fields of its group, {{unsubscribeLink}} and {{signature}}. Write each token as given. A variable without a value for a recipient is removed from their message. {{signature}} inserts the sender's signature on a new step or message, as listed by GET /v1/message-senders: end a body with <p>{{signature}}</p> to sign it, rather than writing the signature yourself.<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}/variables

Request

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

Path parameters

campaignIdstring required

The ID of the campaign.

Query parameters

limitinteger

The number of items to return.

cursorstring

A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the pagination.nextLink value returned in a previous response to request subsequent results.

Response

A page of the variables the campaign can use.

deprecationsstring[]

Example response

{
  "data": {
    "items": [
      {
        "token": "{{customFieldValues.grp_bc984b3f-0386-434d-82d7-a91eb6badd71.Deal stage}}",
        "key": "customFieldValues.grp_bc984b3f-0386-434d-82d7-a91eb6badd71.Deal stage",
        "label": "Deal stage",
        "source": "customField",
        "type": "text",
        "group": {
          "id": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
          "name": "Leads"
        }
      }
    ],
    "pagination": {
      "nextLink": "https://api.folk.app/v1/campaigns/cmp_9b2f1c1e-2b8a-4d1e-8f5a-3c2d1e0f9a8b/variables?limit=20&cursor=eyJvZmZzZXQiOjIwfQ%3D%3D"
    }
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes