Optimizely Campaign icon

Optimizely Campaign

Optimizely Campaign

Actions4

Recipient → Create

AI-generated

Summary

Create a recipient in a specified recipient list, mapping column data to attributes and using the selected recipient ID field for unique identification. Optionally triggers an opt-in process; if updateIfExists is enabled and a 409 conflict occurs, the operation retries as an update.

Inputs

  • recipientListId (required) — Pick which recipient list to work on
  • recipientIdField (required) — Select the field that will be used as the unique recipient ID. This field will be used for matching.
  • updateIfExists — If checked, an existing recipient will be updated instead of failing when the recipient already exists.
  • triggerOptIn — If checked, an Opt-In process is triggered.
  • optInProcess (required) — Select the Opt-In process to trigger
  • columns (required) — Map incoming data to recipient attributes. The Recipient ID Field selected above must be mapped here.

Output shape

On success: { success: true, operation: 'create', data: }. If updateIfExists resolves a 409 conflict: { success: true, operation: 'update', data: }. On failure: NodeApiError is thrown.

The API returns the created/updated recipient resource body.

Examples

Example 1: Create a new recipient in a list, triggering opt-in with a specified process.

Set recipientListId, recipientIdField, triggerOptIn=true, optInProcess=, and map columns including the recipientIdField value.

Links

Discussion