FOfolk
Campaigns

List message senders

Changed on

Retrieve a paginated list of the email addresses you can send campaigns from, last used first: those you own, those shared with the workspace, and every sender of the workspace for admins. Senders still waiting for verification are left out. Each sender comes with its signature, which is what {{signature}} inserts on a new step or message: 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/message-senders

Request

  • Base URL
    https://api.folk.app
  • URL
    https://api.folk.app/v1/message-senders
  • Auth
    HTTP bearer

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 senders you can send campaigns from.

deprecationsstring[]

Example response

{
  "data": {
    "items": [
      {
        "id": "snd_4c3b2a19-8f7e-4d6c-9b5a-1e2f3d4c5b6a",
        "email": "john.doe@example.com",
        "displayName": "John Doe",
        "provider": "custom_domain",
        "supportsSequences": true,
        "signature": "<p>John Doe</p><p>Head of Sales, Example Inc.</p>"
      }
    ],
    "pagination": {
      "nextLink": "https://api.folk.app/v1/message-senders?limit=20&cursor=eyJvZmZzZXQiOjIwfQ%3D%3D"
    }
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes