Single send

Send a survey to one or more recipients directly by email — without creating a contact list first.

You can attach custom attributes to each recipient by passing the attributes object. These values will be stored alongside the response and can be used for filtering and segmentation in the dashboard (e.g. plan, country, customer_id).

By default the survey is sent immediately. Use scheduled_at to delay delivery.

Prerequisites

• An active outgoing mailbox connected in Team → Emails (https://app.responsly.com/team/emails). Without it, the API returns 400.
• Editor access to the survey (form_id).
• Single Send must be enabled for your account.

Endpoint

POST https://api.interankiety.pl/v1/distributions/send

Authentication: Bearer token.

Body parameters

Name	Type	Description
form_id	string	ID of the survey to send. Required.
recipients	array	List of recipient objects. Required. At least one recipient must be provided.
recipients[].email	string	Email address of the recipient. Required.
recipients[].name	string	Recipient name. Optional. Currently accepted but not used in the email content.
recipients[].attributes	object	Custom key-value pairs attached to the survey link. Stored with the response when matching hidden variables exist on the form. See Attributes.
channel	string	Delivery channel. Currently only email is supported. Defaults to email.
scheduled_at	string	ISO 8601 datetime when the email should be sent. Omit to send immediately. If the value has no timezone (Z or offset), it is interpreted in the API user’s timezone. Example: 2024-09-01T09:00:00Z.

Attributes

Pass custom data under recipients[].attributes. Each key becomes a URL query parameter on the survey link in the email (except reserved keys listed below).

Rule	Details
Key format	Letters, numbers, and underscores only (A–Z, a–z, 0–9, _).
Value length	Max 500 characters per value.
Hidden variables	Attribute keys must match hidden variables configured on the form (case-sensitive) to be saved with the response.
Example keys	customer_id, OrderNumber, Salesperson

Reserved attribute keys

Key	Description
email_subject	Custom subject line for the survey email (max 150 characters). Not appended to the survey URL.

Request

cURL

curl --request POST \
  --url 'https://api.interankiety.pl/v1/distributions/send' \
  --header 'Authorization: Bearer <Access Token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "form_id": "YOUR_FORM_ID",
    "channel": "email",
    "scheduled_at": "2024-09-01T09:00:00Z",
    "recipients": [
      {
        "email": "[email protected]",
        "name": "Jane Doe",
        "attributes": {
          "customer_id": "12345",
          "OrderNumber": "ORD-9876",
          "email_subject": "We would love your feedback!"
        }
      }
    ]
  }'

Response

201 Created

{
  "items": [
    {
      "email": "[email protected]",
      "status": "queued",
      "scheduled_at": "2024-09-01T09:00:00.000000Z"
    }
  ]
}

scheduled_at is included only when a future send time was requested.

Error responses

Status	When
400	No active outgoing mailbox configured for the team.
403	Account not enabled for Single Send, or no editor access to the form.
422	Validation error (e.g. invalid email, invalid attribute key format).