add purl

Generates a PURL (personalised URL) on the Campaign for one ACTIVE User in the same Organisation. Requires an Organisation Admin session or token, or the Campaign private key as Authorization: Bearer raisely-sk-…; Houston, permission-limited tokens, and non-Organisation-Admin roles get 403. Requires the opaque_purls feature flag. The returned purlUrl contains a bearer credential: store and send it as a secret. Send an optional Idempotency-Key header to make retries safe: the same request with the same key returns the original PURL (200, IDEMPOTENT_REPLAY) with its original URL, expiry, and status, even when it has since expired or been revoked; a request without the header always creates a new PURL. Expiry follows the Campaign's PURL expiry policy (six months when none is configured). Each Organisation has a per-minute and per-day single-generation budget; an invalid destination or field policy is rejected with 400 before spending it.

For custom components:

RaiselyComponents.api.one('campaigns', '{campaign}').all('purls').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 or User not found in the caller's Organisation, or PURL generation is not enabled

409

A PURL already stored under this request's derived idempotency key has a different payload; retry without the Idempotency-Key header

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