Reference

Ask for a sample of a count

POST /v1/sample-requests. Starts a sample of about 10 records of a counted audience: the person then confirms a work email address and downloads it once.

Generated from the contractsView as Markdown

POST /v1/sample-requests

Starts a sample of about 10 records of a counted audience: the person then confirms a work email address and downloads it once. The count must allow a sample under the caller's rules (25 records or more, not one company). Never returns records.

Property	Value
Endpoint	`POST https://mydatahub.emailmovers.com/v1/sample-requests`
Operation id	`createSampleRequest`
Cost	Free (0 credits)
Access	An API key or an OAuth 2.1 token with the scope `samples:request`.
Idempotency-Key	Optional. Makes a retry safe.
Tag	Samples

Request

Parameters

Name	In	Type	Required	Description
`MyDataHub-Version`	header	string	no	The dated API version, pinned per key when left out. Non-breaking changes ship as new dates; the path major changes only for breaking changes, with a 12 month deprecation window.
`Idempotency-Key`	header	string	no	Makes the request safe to retry: the same key returns the stored response. Keys are kept for the life of the organisation.

Body

Member	Type	Required	Description
`count_id`	string	yes	Format: a count id: cnt_ followed by 20 base32 characters (A to Z and 2 to 7), such as cnt_7K2PQ4MAXN3R6TBY5WDZ.

Example request

curl -X POST "https://mydatahub.emailmovers.com/v1/sample-requests" \
  -H "Authorization: Bearer $MYDATAHUB_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "count_id": "cnt_7K2PQ4MAXN3R6TBY5WDZ"
}'

Responses

201: The request, waiting for the address.

Headers: RateLimit, RateLimit-Policy, Location.

Member	Type	Always present	Description
`id`	string	yes	Format: a sample request id: smr_ followed by a 26 character ULID in upper case Crockford base32, such as smr_01JB4P2Q5W8ZAK8Q2V7XN3M9R6.
`count_id`	string	yes	Format: a count id: cnt_ followed by 20 base32 characters (A to Z and 2 to 7), such as cnt_7K2PQ4MAXN3R6TBY5WDZ.
`status`	enum: `awaiting_email`, `email_sent`, `confirmed`, `downloaded`, `expired`	yes	awaiting_email until the address is sent; email_sent once it was checked (a refused address reads the same); confirmed once the link is opened; downloaded once the sample is served; expired after its time.
`created_at`	string (date-time)	yes
`expires_at`	string (date-time)	yes	When the request, or the link emailed for it, stops working: 24 hours.

Example response

{
  "id": "smr_01JB4P2Q5W8ZAK8Q2V7XN3M9R6",
  "count_id": "cnt_7K2PQ4MAXN3R6TBY5WDZ",
  "status": "awaiting_email",
  "created_at": "2026-10-11T10:00:00Z",
  "expires_at": "2026-10-12T10:00:00Z"
}

Errors

Every error is a problem object with a code and a next_step. Every response carries the RateLimit and RateLimit-Policy headers; see Rate limits.

Status	Problem codes	When
400	`invalid-request`, `idempotency-key-required`, `unsupported-version`	The request could not be read, or an Idempotency-Key is missing.
401	`authentication-required`, `account-required`	Sign in (OAuth) or send an API key (authentication-required), or create a free account for what the anonymous tier does not cover (account-required).
403	`insufficient-scope`, `confirmation-required`, `business-details-required`, `licence-acceptance-required`, `dpa-acceptance-required`, `agent-budget-exceeded`	The token lacks a scope (insufficient-scope, with required_scope and a WWW-Authenticate step-up challenge); no person confirmed the spend and no agent key covers it (confirmation-required, with an approval_url); an agent key's per-order cap or monthly budget does not cover it (agent-budget-exceeded); an account made by self-serve sign-up has not yet confirmed its business name and that it is a UK business, which its first order needs (business-details-required); the order needs the Data Licence and Sharing Agreement accepted at the version in force (licence-acceptance-required); or a suppression upload comes before the organisation has accepted the Article 28 data processing agreement in force (dpa-acceptance-required). Nothing is charged.
404	`not-found`	No such object for this organisation.
409	`idempotency-key-reused`, `quote-expired`, `order-not-ready`, `order-not-cancellable`	An Idempotency-Key reused with different parameters, an expired machine quote, or an object in the wrong state.
422	`validation-failed`, `quote-required`, `dataset-unavailable`	The request is not valid. errors lists every problem with a JSON pointer and did_you_mean.
429	`rate-limited`	Too many requests. Wait for Retry-After.
Any other failure	`internal-error`, `service-unavailable`, `tps-screen-expired`	Something failed on our side (500 internal-error) or the service is briefly unavailable (503 service-unavailable, with Retry-After). Nothing was charged; retry with the same Idempotency-Key. A count, sample, quote or order with telephone in play is also refused with 503 tps-screen-expired, with no Retry-After, while the dataset version's TPS and CTPS screen is more than 28 days old.