Skip to content
For LLMsView as Markdown·

Optimove ​

CRM marketing platform for iGaming with customer segmentation, campaigns, and lifecycle management.

DetailValue
CategoryiGaming
Base URLhttps://api4.optimove.net
AuthenticationAPI Key
Endpoints9
Connector keyoptimove

Using Optimove in a workflow ​

  1. Go to Connections and click New Connection.
  2. Pick Optimove from the marketplace.
  3. Enter your credentials (see Authentication above for what's expected).
  4. In a workflow, drop an API Call node and select this connection.
  5. Pick the operation you need from the Operation dropdown. The full list is below.

Available endpoints ​

EndpointSummary
GET /General/GetLastDataUpdateLast data update timestamp
GET /Model/GetCustomerAttributeListCustomer attributes
GET /Model/GetLifecycleStageListLifecycle stages
GET /Model/GetMicrosegmentListMicrosegments
GET /Actions/GetAllActionsMarketing actions
GET /Actions/GetExecutedCampaignDetailsCampaign details
GET /Actions/GetPromoCodesPromo codes
GET /Customers/GetCustomerAttributesCustomer attribute values
GET /Segments/GetCustomersByValueSegmentCustomers by value segment

Each endpoint is documented in full below. Use the outline on the right to jump to one.

GET /General/GetLastDataUpdate ​

Last data update timestamp

DetailValue
Operation IDcrm.getLastDataUpdate
MethodGET
Path/General/GetLastDataUpdate

Parameters ​

No parameters.

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your Optimove connection from the Connection dropdown.
  3. In the Operation dropdown, select crm.getLastDataUpdate.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Optimove API reference.

GET /Model/GetCustomerAttributeList ​

Customer attributes

DetailValue
Operation IDcrm.getCustomerAttributes
MethodGET
Path/Model/GetCustomerAttributeList

Parameters ​

No parameters.

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your Optimove connection from the Connection dropdown.
  3. In the Operation dropdown, select crm.getCustomerAttributes.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Optimove API reference.

GET /Model/GetLifecycleStageList ​

Lifecycle stages

DetailValue
Operation IDcrm.getLifecycleStages
MethodGET
Path/Model/GetLifecycleStageList

Parameters ​

No parameters.

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your Optimove connection from the Connection dropdown.
  3. In the Operation dropdown, select crm.getLifecycleStages.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Optimove API reference.

GET /Model/GetMicrosegmentList ​

Microsegments

DetailValue
Operation IDcrm.getMicrosegments
MethodGET
Path/Model/GetMicrosegmentList

Parameters ​

No parameters.

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your Optimove connection from the Connection dropdown.
  3. In the Operation dropdown, select crm.getMicrosegments.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Optimove API reference.

GET /Actions/GetAllActions ​

Marketing actions

DetailValue
Operation IDcrm.getAllActions
MethodGET
Path/Actions/GetAllActions

Parameters ​

No parameters.

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your Optimove connection from the Connection dropdown.
  3. In the Operation dropdown, select crm.getAllActions.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Optimove API reference.

GET /Actions/GetExecutedCampaignDetails ​

Campaign details

DetailValue
Operation IDcrm.getCampaignDetails
MethodGET
Path/Actions/GetExecutedCampaignDetails

Parameters ​

NameLocationTypeRequired
DatequerystringYes

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your Optimove connection from the Connection dropdown.
  3. In the Operation dropdown, select crm.getCampaignDetails.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Optimove API reference.

GET /Actions/GetPromoCodes ​

Promo codes

DetailValue
Operation IDcrm.getPromoCodes
MethodGET
Path/Actions/GetPromoCodes

Parameters ​

NameLocationTypeRequired
DatequerystringYes

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your Optimove connection from the Connection dropdown.
  3. In the Operation dropdown, select crm.getPromoCodes.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Optimove API reference.

GET /Customers/GetCustomerAttributes ​

Customer attribute values

DetailValue
Operation IDcrm.getCustomerAttributeValues
MethodGET
Path/Customers/GetCustomerAttributes

Parameters ​

NameLocationTypeRequired
CustomerIDsquerystringYes
CustomerAttributesquerystringYes

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your Optimove connection from the Connection dropdown.
  3. In the Operation dropdown, select crm.getCustomerAttributeValues.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Optimove API reference.

GET /Segments/GetCustomersByValueSegment ​

Customers by value segment

DetailValue
Operation IDcrm.getCustomersByValueSegment
MethodGET
Path/Segments/GetCustomersByValueSegment

Parameters ​

NameLocationTypeRequired
valueSegmentIDqueryintegerYes

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your Optimove connection from the Connection dropdown.
  3. In the Operation dropdown, select crm.getCustomersByValueSegment.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Optimove API reference.