Extole Campaign Flow Steps API
The Campaign Flow Steps API from Extole — 12 operation(s) for campaign flow steps.
Extole Campaign Flow Steps API is one of 44 APIs that Extole publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Campaign Flow Steps. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 21 operations across 12 paths, and defines 78 schemas. It is described by OpenAPI 3.0.1, at version 1.0.
Requests are made against a single base URL, https://{brand}.extole.io.
21 operations
12 paths
78 schemas
3 DELETE12 GET3 POST3 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Extole Campaign Flow Steps API declares
3 security schemes
for authenticating requests.
An API key is passed in the cookie as extole_token (COOKIE).
An API key is passed in the header as Authorization (HEADER).
An API key is passed in the query as access_token (QUERY).
By default, every request must be authenticated.
Paths & Operations 21
Across 12 paths, the API surfaces 21 operations — 3 DELETE, 12 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
Campaign Flow Steps 21
GET
/v2/campaigns/{campaignId}{version}/flow-steps
List campaign flow steps
POST
/v2/campaigns/{campaignId}{version}/flow-steps
Create a campaign flow step
GET
/v2/campaigns/{campaignId}{version}/flow-steps/built
List built campaign flow steps
GET
/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}
Get a campaign flow step
PUT
/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}
Update a campaign flow step
DELETE
/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}
Delete a campaign flow step
GET
/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/built
Get a built campaign flow step
GET
/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/apps
List campaign flow step apps
POST
/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/apps
Create a campaign flow step app
GET
/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/apps/built
List built campaign flow step apps
GET
/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/apps/{flowStepAppId}
Get a campaign flow step app
PUT
/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/apps/{flowStepAppId}
Update a campaign flow step app
DELETE
/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/apps/{flowStepAppId}
Delete a campaign flow step app
GET
/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/apps/{flowStepAppId}/built
Get a built campaign flow step app
GET
/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/metrics
List campaign flow step metrics
POST
/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/metrics
Create a campaign flow step metric
GET
/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/metrics/built
List built campaign flow step metrics
GET
/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/metrics/{flowStepMetricId}
Get a campaign flow step metric
PUT
/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/metrics/{flowStepMetricId}
Update a campaign flow step metric
DELETE
/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/metrics/{flowStepMetricId}
Delete a campaign flow step metric
GET
/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}/metrics/{flowStepMetricId}/built
Get a built campaign flow step metric
Schemas 78
The contract defines 78 schemas that model the data the API accepts and returns. The most detailed are BuiltCampaignFlowStepResponse (14 properties), CampaignFlowStepResponse (14 properties), CampaignFlowStepCreateRequest (13 properties), CampaignFlowStepUpdateRequest (13 properties). Each schema is shown below with its type and property counts.
SequenceInCampaignFlowStepResponse
The sequence as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignFlowStepAppTypeCreateRequest
object
1 property
DescriptionInCampaignFlowStepAppResponse
The description as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignFlowStepResponse
object
14 properties
14 required
CampaignFlowStepCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/flow-steps request.
13 properties
9 required
DescriptionInCampaignFlowStepAppUpdateRequest
Choose between static or dynamic description
UnitInCampaignFlowStepMetricUpdateRequest
Choose between static or dynamic unit
NameInCampaignFlowStepAppTypeResponse
The name as configured: a literal value, or an expression (type:string) when defined dynamically.
SingularNounNameInCampaignFlowStepWordsRequest
Choose between static or dynamic singular noun name
DescriptionInCampaignFlowStepUpdateRequest
Choose between static or dynamic description
NameInCampaignFlowStepMetricCreateRequest
Choose between static or dynamic name
DescriptionInCampaignFlowStepResponse
The description as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignFlowStepAppResponse
object
Stored campaign flow step app definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
6 properties
6 required
CampaignFlowStepWordsResponse
object
5 properties
IconTypeInCampaignFlowStepUpdateRequest
Choose between static or dynamic icon type
TagsInCampaignFlowStepMetricUpdateRequest
Choose between static or dynamic tags
IconColorInCampaignFlowStepCreateRequest
Choose between static or dynamic icon color
CampaignFlowStepAppCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/flow-steps/{flowStepId}/apps request.
5 properties
2 required
SingularNounNameInCampaignFlowStepWordsResponse
The singular noun name as configured: a literal value, or an expression (type:string) when defined dynamically.
PersonCountingNameInCampaignFlowStepWordsRequest
Choose between static or dynamic person counting name
StepNameInCampaignFlowStepUpdateRequest
Choose between static or dynamic step name
DescriptionInCampaignFlowStepMetricUpdateRequest
Choose between static or dynamic description
CampaignFlowStepMetricResponse
object
Stored campaign flow step metric definition. Fields name, description, expression, unit, and tags are unevaluated and appear in buildtime-evaluatable form.
8 properties
8 required
NameInCampaignFlowStepAppResponse
The name as configured: a literal value, or an expression (type:string) when defined dynamically.
DescriptionInCampaignFlowStepCreateRequest
Choose between static or dynamic description
VerbNameInCampaignFlowStepWordsResponse
The verb name as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignFlowStepAppUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/flow-steps/{flowStepId}/apps/{flowStepAppId} request.
5 properties
IconColorInCampaignFlowStepUpdateRequest
Choose between static or dynamic icon color
NameInCampaignFlowStepAppTypeCreateRequest
Choose between static or dynamic name
UnitInCampaignFlowStepMetricResponse
The unit as configured: a literal value, or an expression (type:string) when defined dynamically.
IconTypeInCampaignFlowStepCreateRequest
Choose between static or dynamic icon type
FlowPathInCampaignFlowStepResponse
The flow path as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignFlowStepAppResponse
object
5 properties
5 required
CampaignFlowStepAppTypeResponse
object
1 property
TagsInCampaignFlowStepMetricResponse
The tags as configured: a literal value, or an expression (type:string) when defined dynamically.
VerbNameInCampaignFlowStepWordsRequest
Choose between static or dynamic verb name
IconTypeInCampaignFlowStepResponse
The icon type as configured: a literal value, or an expression (type:string) when defined dynamically.
StepNameInCampaignFlowStepResponse
The step name as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignFlowStepMetricUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/flow-steps/{flowStepId}/metrics/{flowStepMetricId} request.
7 properties
ExpressionInCampaignFlowStepMetricCreateRequest
Choose between static or dynamic expression
BuiltCampaignFlowStepAppTypeResponse
object
1 property
StepNameInCampaignFlowStepCreateRequest
Choose between static or dynamic step name
DescriptionInCampaignFlowStepAppCreateRequest
Choose between static or dynamic description
NameInCampaignFlowStepAppUpdateRequest
Choose between static or dynamic name
DescriptionInCampaignFlowStepMetricResponse
The description as configured: a literal value, or an expression (type:string) when defined dynamically.
RateNameInCampaignFlowStepWordsResponse
The rate name as configured: a literal value, or an expression (type:string) when defined dynamically.
IconColorInCampaignFlowStepResponse
The icon color as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignFlowStepWordsResponse
object
5 properties
SequenceInCampaignFlowStepCreateRequest
Choose between static or dynamic sequence
FlowPathInCampaignFlowStepCreateRequest
Choose between static or dynamic flow path
NameInCampaignFlowStepUpdateRequest
Choose between static or dynamic name
TagsInCampaignFlowStepResponse
The tags as configured: a literal value, or an expression (type:string) when defined dynamically.
PluralNounNameInCampaignFlowStepWordsResponse
The plural noun name as configured: a literal value, or an expression (type:string) when defined dynamically.
TagsInCampaignFlowStepCreateRequest
Choose between static or dynamic tags
NameInCampaignFlowStepAppCreateRequest
Choose between static or dynamic name
RestExceptionResponse
object
Represents the API error response
5 properties
5 required
ComponentReferenceResponse
object
2 properties
TagsInCampaignFlowStepMetricCreateRequest
Choose between static or dynamic tags
ExpressionInCampaignFlowStepMetricUpdateRequest
Choose between static or dynamic expression
BuiltCampaignFlowStepMetricResponse
object
8 properties
8 required
ComponentReferenceRequest
object
2 properties
CampaignFlowStepUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/flow-steps/{flowStepId} request.
13 properties
CampaignFlowStepMetricCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/flow-steps/{flowStepId}/metrics request.
7 properties
5 required
CampaignFlowStepWordsRequest
object
5 properties
FlowPathInCampaignFlowStepUpdateRequest
Choose between static or dynamic flow path
NameInCampaignFlowStepMetricResponse
The name as configured: a literal value, or an expression (type:string) when defined dynamically.
DescriptionInCampaignFlowStepMetricCreateRequest
Choose between static or dynamic description
CampaignFlowStepResponse
object
Stored campaign flow step definition. Fields flowpath, sequence, stepname, icontype, tags, name, iconcolor, and description are unevaluated and appear in build…
14 properties
14 required
NameInCampaignFlowStepResponse
The name as configured: a literal value, or an expression (type:string) when defined dynamically.
SequenceInCampaignFlowStepUpdateRequest
Choose between static or dynamic sequence
PluralNounNameInCampaignFlowStepWordsRequest
Choose between static or dynamic plural noun name
PersonCountingNameInCampaignFlowStepWordsResponse
The person counting name as configured: a literal value, or an expression (type:string) when defined dynamically.
RateNameInCampaignFlowStepWordsRequest
Choose between static or dynamic rate name
NameInCampaignFlowStepCreateRequest
Choose between static or dynamic name
NameInCampaignFlowStepMetricUpdateRequest
Choose between static or dynamic name
UnitInCampaignFlowStepMetricCreateRequest
Choose between static or dynamic unit
TagsInCampaignFlowStepUpdateRequest
Choose between static or dynamic tags
ExpressionInCampaignFlowStepMetricResponse
The expression as configured: a literal value, or an expression (type:string) when defined dynamically.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Extole 12
Other APIs Extole publishes across the network.
Extole Audiences API
Extole Authentication API
Extole Batch Jobs API
Extole Blocks API
Extole Campaign Controllers Actions API
Extole Campaign Controllers API
Extole Campaign Controllers Triggers API
Extole Campaigns API
Extole Components API
Extole Components Grants API
Extole Components Settings API
Extole Components Subscriptions API
#Campaign Flow Steps