purls campaign

Generates PURLs on the Campaign for up to 100 Users sharing one destination and field policy. Authentication, feature flag, Idempotency-Key, and expiry behave as for POST /campaigns/{campaign}/purls; with a key, each User's PURL is replayed independently of input order. User UUIDs are lower-cased and deduplicated (first occurrence wins); results follow that order. The request returns 200 even when some or every User fails: a failed item carries only userUuid and error.code, and never rolls back its siblings. As on the single route, an invalid shared destination or field policy is rejected with 400 before any PURL is minted or any budget is spent. Each Organisation has a per-minute and per-day budget of batch calls and of deduplicated Users; unknown Users still count.

For custom components:

RaiselyComponents.api.one('campaigns', '{campaign}').all('purls').all('batch').post(data = {}, params = {}, headers = {}) => Promise<{result}>

See Restie Response Data for a more detailed overview of responses through the client wrapper

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The uuid, path or domain of the campaign to associate with the request

Body Params
data
object
required
Headers
string
length between 1 and 128

1-128 visible ASCII characters (no spaces). Never stored or echoed.

Responses

400

Malformed request, destination, or field policy (subcode invalid_purl_generation_request), or an invalid Idempotency-Key header (subcode invalid_idempotency_key)

404

Campaign not found in the caller's Organisation, or PURL generation is not enabled

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json