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
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
400Malformed request, destination, or field policy (subcode invalid_purl_generation_request), or an invalid Idempotency-Key header (subcode invalid_idempotency_key)
404Campaign or User not found in the caller's Organisation, or PURL generation is not enabled
409A PURL already stored under this request's derived idempotency key has a different payload; retry without the Idempotency-Key header