GrowthZone REST API API Reference

undefined

API Endpoint
https://app.memberzone.org
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0

Paths

Workflow

GET /api/workflows

options: string
in query

(no description)

200 OK
ListViewReturnModel<WorkflowCollectionItemModel>

OK

Response Example (200 OK) 
{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}
Workflow

POST /api/workflows

WorkflowCollectionItemModelFilter

undefined

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "Criteria": "string"
}
200 OK
ListViewReturnModel<WorkflowCollectionItemModel>

OK

Response Example (200 OK) 
{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}
Workflow

POST /api/workflows/{workflowid}

AddEditWorkflowDialog

undefined

workflowid: string
in path

(no description)

Request Example
{
  "WorkflowId": "integer",
  "Name": "string",
  "Description": "string",
  "SystemScheduleTypeId": "string",
  "DailyScheduleOptions": "string",
  "WeeklyScheduleOptions": "string",
  "WorkflowSources": "string",
  "IsActive": "boolean",
  "AllowRepeatedSteps": "boolean",
  "AllowReEntry": "boolean",
  "AuditId": "integer",
  "TenantId": "integer",
  "ScheduleOptionsJson": "string"
}
200 OK
WorkflowCollectionItemModel

OK

Response Example (200 OK) 
{
  "WorkflowId": "integer",
  "Name": "string",
  "Author": "string",
  "NumberOfSteps": "integer",
  "Lists": "string",
  "TotalParticipants": "integer",
  "ScheduleDescription": "string",
  "ScheduleOptionsJson": "string",
  "ActiveInProgram": "integer",
  "EarlyOptOuts": "integer",
  "CompletedProgram": "integer",
  "IsActive": "boolean",
  "ListsArray": "string",
  "SystemScheduleTypeId": "string"
}
Workflow

GET /api/workflows/{workflowid}/general

workflowid: integer
in path

(no description)

200 OK
WorkflowGeneralModel

OK

Response Example (200 OK) 
{
  "WorkflowId": "integer",
  "Name": "string",
  "Description": "string",
  "SystemScheduleTypeId": "string",
  "Instruction": "string",
  "DailyScheduleOptions": "string",
  "WeeklyScheduleOptions": "string",
  "WorkflowPosiSources": "string",
  "WorkflowAntiSources": "string",
  "IsActive": "boolean",
  "AllowRepeatedSteps": "boolean",
  "AllowReEntry": "boolean",
  "WidgetData": "string",
  "Actions": "string",
  "AuditId": "integer",
  "TenantId": "integer",
  "ScheduleOptionsJson": "string"
}
Workflow

POST /api/workflows/{workflowid}/general

WorkflowGeneralModel

undefined

workflowid: integer
in path

(no description)

Request Example
{
  "WorkflowId": "integer",
  "Name": "string",
  "Description": "string",
  "SystemScheduleTypeId": "string",
  "Instruction": "string",
  "DailyScheduleOptions": "string",
  "WeeklyScheduleOptions": "string",
  "WorkflowPosiSources": "string",
  "WorkflowAntiSources": "string",
  "IsActive": "boolean",
  "AllowRepeatedSteps": "boolean",
  "AllowReEntry": "boolean",
  "WidgetData": "string",
  "Actions": "string",
  "AuditId": "integer",
  "TenantId": "integer",
  "ScheduleOptionsJson": "string"
}
200 OK
WorkflowGeneralModel

OK

Response Example (200 OK) 
{
  "WorkflowId": "integer",
  "Name": "string",
  "Description": "string",
  "SystemScheduleTypeId": "string",
  "Instruction": "string",
  "DailyScheduleOptions": "string",
  "WeeklyScheduleOptions": "string",
  "WorkflowPosiSources": "string",
  "WorkflowAntiSources": "string",
  "IsActive": "boolean",
  "AllowRepeatedSteps": "boolean",
  "AllowReEntry": "boolean",
  "WidgetData": "string",
  "Actions": "string",
  "AuditId": "integer",
  "TenantId": "integer",
  "ScheduleOptionsJson": "string"
}
Workflow

POST /api/workflows/{workflowid}/staus/update

WorkflowGeneralModel

undefined

workflowid: integer
in path

(no description)

Request Example
{
  "WorkflowId": "integer",
  "Name": "string",
  "Description": "string",
  "SystemScheduleTypeId": "string",
  "Instruction": "string",
  "DailyScheduleOptions": "string",
  "WeeklyScheduleOptions": "string",
  "WorkflowPosiSources": "string",
  "WorkflowAntiSources": "string",
  "IsActive": "boolean",
  "AllowRepeatedSteps": "boolean",
  "AllowReEntry": "boolean",
  "WidgetData": "string",
  "Actions": "string",
  "AuditId": "integer",
  "TenantId": "integer",
  "ScheduleOptionsJson": "string"
}
200 OK
WorkflowGeneralModel

OK

Response Example (200 OK) 
{
  "WorkflowId": "integer",
  "Name": "string",
  "Description": "string",
  "SystemScheduleTypeId": "string",
  "Instruction": "string",
  "DailyScheduleOptions": "string",
  "WeeklyScheduleOptions": "string",
  "WorkflowPosiSources": "string",
  "WorkflowAntiSources": "string",
  "IsActive": "boolean",
  "AllowRepeatedSteps": "boolean",
  "AllowReEntry": "boolean",
  "WidgetData": "string",
  "Actions": "string",
  "AuditId": "integer",
  "TenantId": "integer",
  "ScheduleOptionsJson": "string"
}
Workflow

GET /api/workflows/base/{workflowid}

workflowid: integer
in path

(no description)

200 OK
WorkflowBaseModel

OK

Response Example (200 OK) 
{
  "WorkflowId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Actions": "string"
}
Workflow

POST /api/workflows/copy/{workflowid}

workflowid: integer
in path

(no description)

200 OK

OK

Workflow

DELETE /api/workflows/deleteworkflowstep/{workflowstepid}/{auditid}

workflowstepid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK

OK

Workflow

GET /api/workflows/download/workflowmetrics/{workflowid}

workflowid: integer
in path

(no description)

200 OK
HttpResponseMessage

OK

Response Example (200 OK) 
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}
Workflow

GET /api/workflows/getworkflow/{workflowid}

workflowid: string
in path

(no description)

200 OK
AddEditWorkflowDialog

OK

Response Example (200 OK) 
{
  "WorkflowId": "integer",
  "Name": "string",
  "Description": "string",
  "SystemScheduleTypeId": "string",
  "DailyScheduleOptions": "string",
  "WeeklyScheduleOptions": "string",
  "WorkflowSources": "string",
  "IsActive": "boolean",
  "AllowRepeatedSteps": "boolean",
  "AllowReEntry": "boolean",
  "AuditId": "integer",
  "TenantId": "integer",
  "ScheduleOptionsJson": "string"
}
Workflow

DELETE /api/workflows/workflow/{workflowid}/{auditid}

workflowid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK

OK

Workflow

GET /api/workflows/workflowmetrics/line

200 OK
ChartData

OK

Response Example (200 OK) 
{
  "series": "string",
  "data": "string",
  "extraStats": "string"
}
Workflow

GET /api/workflows/workflowmetrics/pie

200 OK
ChartData

OK

Response Example (200 OK) 
{
  "series": "string",
  "data": "string",
  "extraStats": "string"
}
Workflow

GET /api/workflows/workflowmetrics/scoreboard

200 OK
ScoreboardDatapoint

OK

type
ScoreboardDatapoint
Response Example (200 OK) 
[
  {
    "Name": "string",
    "Value": "string",
    "Hint": "string"
  }
]
Workflow

GET /api/workflows/workflowstep/{workflowid}/{workflowstepid}

workflowid: integer
in path

(no description)

workflowstepid: integer
in path

(no description)

200 OK
WorkflowStepAddEditModel

OK

Response Example (200 OK) 
{
  "WorkflowStepId": "integer",
  "WorkflowId": "integer",
  "AuditId": "integer",
  "PreviousStepId": "string",
  "LogicStepId": "string",
  "SystemStepTypeId": "string",
  "StepOptionsJson": "string",
  "WorkflowStepTypeId": "string",
  "CachedDescription": "string",
  "WaitOptions": "string",
  "WaitUntilOptions": "string",
  "TemplateTypeId": "string",
  "EmailTemplateId": "string",
  "EmailDesignerTemplateId": "string",
  "TemplateId": "string",
  "TemplateName": "string",
  "SendEmailStepOptions": "string",
  "CreateFollowUpReminderOptions": "string",
  "AddToListOptions": "string",
  "RemoveFromListOptions": "string",
  "MoveToListOptions": "string",
  "AddTagOptions": "string",
  "LogicBranchOptions": "string",
  "SkipOrGotoStepOptions": "string",
  "IsActive": "boolean"
}
Workflow

POST /api/workflows/workflowstep/{workflowid}/{workflowstepid}

WorkflowStepAddEditModel

undefined

workflowid: string
in path

(no description)

workflowstepid: string
in path

(no description)

Request Example
{
  "WorkflowStepId": "integer",
  "WorkflowId": "integer",
  "AuditId": "integer",
  "PreviousStepId": "string",
  "LogicStepId": "string",
  "SystemStepTypeId": "string",
  "StepOptionsJson": "string",
  "WorkflowStepTypeId": "string",
  "CachedDescription": "string",
  "WaitOptions": "string",
  "WaitUntilOptions": "string",
  "TemplateTypeId": "string",
  "EmailTemplateId": "string",
  "EmailDesignerTemplateId": "string",
  "TemplateId": "string",
  "TemplateName": "string",
  "SendEmailStepOptions": "string",
  "CreateFollowUpReminderOptions": "string",
  "AddToListOptions": "string",
  "RemoveFromListOptions": "string",
  "MoveToListOptions": "string",
  "AddTagOptions": "string",
  "LogicBranchOptions": "string",
  "SkipOrGotoStepOptions": "string",
  "IsActive": "boolean"
}
200 OK
WorkflowStepCollectionItemModel

OK

Response Example (200 OK) 
{
  "Pending": "integer",
  "WorkflowStepId": "integer",
  "PreviousStepId": "string",
  "WorkflowId": "integer",
  "WorkflowStepTypeId": "string",
  "LogicStepId": "string",
  "IsInverseLogic": "boolean",
  "StepOptionsJson": "string",
  "WorkflowStepType": "string",
  "CachedDescription": "string",
  "IsActive": "boolean",
  "LogicChain": "string"
}
Workflow

GET /api/workflows/workflowstep/{workflowid}/{workflowstepid}/pending

workflowid: integer
in path

(no description)

workflowstepid: integer
in path

(no description)

200 OK
StepPendingContactsModel

OK

Response Example (200 OK) 
{
  "WorkflowStepId": "integer",
  "WorkflowId": "integer",
  "Contacts": "string"
}
Workflow

GET /api/workflows/workflowsteps/{workflowid}

workflowid: integer
in path

(no description)

200 OK
WorkflowStepCollectionModel

OK

Response Example (200 OK) 
{
  "Lanes": "string"
}
Workflow

POST /api/workflows/workflowsteps/{workflowid}

WorkflowStepCollectionModel

undefined

workflowid: integer
in path

(no description)

Request Example
{
  "Lanes": "string"
}
200 OK
WorkflowStepCollectionModel

OK

Response Example (200 OK) 
{
  "Lanes": "string"
}
Workflow

GET /api/workflows/workflowsteps/{workflowid}/lookup

workflowid: integer
in path

(no description)

200 OK
WorkflowStepSelectModel

OK

type
WorkflowStepSelectModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "WorkflowStepId": "integer",
    "Order": "integer",
    "PreviousStepId": "string",
    "Name": "string"
  }
]
Workflow

GET /api/workflows/workflowsteptypes/lookup

200 OK
WorkflowStepTypeSelectModel

OK

type
WorkflowStepTypeSelectModel
Response Example (200 OK) 
[
  {
    "WorkflowStepTypeId": "integer",
    "Name": "string",
    "CachedDescription": "string"
  }
]

Schema Definitions

ListViewReturnModel<WorkflowCollectionItemModel>: object

Criteria: string
CriteriaItems: string
TotalRecordAvailable: string

We typically only return a subset of what is available on the server, but lets show the user what was available

ModelItems: string
Results: string
Example
{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}

WorkflowCollectionItemModelFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
Criteria: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "Criteria": "string"
}

WorkflowBaseModel: object

WorkflowId: integer
AuditId: integer
Name: string
Actions: string
Example
{
  "WorkflowId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Actions": "string"
}

AddEditWorkflowDialog: object

WorkflowId: integer
Name: string
Description: string
SystemScheduleTypeId: string
DailyScheduleOptions: string
WeeklyScheduleOptions: string
WorkflowSources: string
IsActive: boolean
AllowRepeatedSteps: boolean
AllowReEntry: boolean
AuditId: integer
TenantId: integer
ScheduleOptionsJson: string
Example
{
  "WorkflowId": "integer",
  "Name": "string",
  "Description": "string",
  "SystemScheduleTypeId": "string",
  "DailyScheduleOptions": "string",
  "WeeklyScheduleOptions": "string",
  "WorkflowSources": "string",
  "IsActive": "boolean",
  "AllowRepeatedSteps": "boolean",
  "AllowReEntry": "boolean",
  "AuditId": "integer",
  "TenantId": "integer",
  "ScheduleOptionsJson": "string"
}

WorkflowCollectionItemModel: object

WorkflowId: integer
Name: string
Author: string
NumberOfSteps: integer
Lists: string
TotalParticipants: integer
ScheduleDescription: string
ScheduleOptionsJson: string
ActiveInProgram: integer

Number of records in the WorkflowContactState that are still active (no exit reason)

EarlyOptOuts: integer
CompletedProgram: integer

Number of records in the WorkflowContactState that have exit reason set to success

IsActive: boolean
ListsArray: string
SystemScheduleTypeId: string
Example
{
  "WorkflowId": "integer",
  "Name": "string",
  "Author": "string",
  "NumberOfSteps": "integer",
  "Lists": "string",
  "TotalParticipants": "integer",
  "ScheduleDescription": "string",
  "ScheduleOptionsJson": "string",
  "ActiveInProgram": "integer",
  "EarlyOptOuts": "integer",
  "CompletedProgram": "integer",
  "IsActive": "boolean",
  "ListsArray": "string",
  "SystemScheduleTypeId": "string"
}

Object: object

Example
"object"

WorkflowGeneralModel: object

WorkflowId: integer
Name: string
Description: string
SystemScheduleTypeId: string
Instruction: string
DailyScheduleOptions: string
WeeklyScheduleOptions: string
WorkflowPosiSources: string
WorkflowAntiSources: string
IsActive: boolean
AllowRepeatedSteps: boolean
AllowReEntry: boolean
WidgetData: string
Actions: string
AuditId: integer
TenantId: integer
ScheduleOptionsJson: string
Example
{
  "WorkflowId": "integer",
  "Name": "string",
  "Description": "string",
  "SystemScheduleTypeId": "string",
  "Instruction": "string",
  "DailyScheduleOptions": "string",
  "WeeklyScheduleOptions": "string",
  "WorkflowPosiSources": "string",
  "WorkflowAntiSources": "string",
  "IsActive": "boolean",
  "AllowRepeatedSteps": "boolean",
  "AllowReEntry": "boolean",
  "WidgetData": "string",
  "Actions": "string",
  "AuditId": "integer",
  "TenantId": "integer",
  "ScheduleOptionsJson": "string"
}

WorkflowStepCollectionModel: object

Lanes: string
Example
{
  "Lanes": "string"
}

WorkflowStepAddEditModel: object

WorkflowStepId: integer
WorkflowId: integer
AuditId: integer
PreviousStepId: string
LogicStepId: string
SystemStepTypeId: string
StepOptionsJson: string
WorkflowStepTypeId: string
CachedDescription: string
WaitOptions: string
WaitUntilOptions: string
TemplateTypeId: string
EmailTemplateId: string
EmailDesignerTemplateId: string
TemplateId: string
TemplateName: string
SendEmailStepOptions: string
CreateFollowUpReminderOptions: string
AddToListOptions: string
RemoveFromListOptions: string
MoveToListOptions: string
AddTagOptions: string
LogicBranchOptions: string
SkipOrGotoStepOptions: string
IsActive: boolean
Example
{
  "WorkflowStepId": "integer",
  "WorkflowId": "integer",
  "AuditId": "integer",
  "PreviousStepId": "string",
  "LogicStepId": "string",
  "SystemStepTypeId": "string",
  "StepOptionsJson": "string",
  "WorkflowStepTypeId": "string",
  "CachedDescription": "string",
  "WaitOptions": "string",
  "WaitUntilOptions": "string",
  "TemplateTypeId": "string",
  "EmailTemplateId": "string",
  "EmailDesignerTemplateId": "string",
  "TemplateId": "string",
  "TemplateName": "string",
  "SendEmailStepOptions": "string",
  "CreateFollowUpReminderOptions": "string",
  "AddToListOptions": "string",
  "RemoveFromListOptions": "string",
  "MoveToListOptions": "string",
  "AddTagOptions": "string",
  "LogicBranchOptions": "string",
  "SkipOrGotoStepOptions": "string",
  "IsActive": "boolean"
}

WorkflowStepCollectionItemModel: object

Pending: integer
WorkflowStepId: integer
PreviousStepId: string
WorkflowId: integer
WorkflowStepTypeId: string
LogicStepId: string
IsInverseLogic: boolean
StepOptionsJson: string
WorkflowStepType: string
CachedDescription: string
IsActive: boolean
LogicChain: string
Example
{
  "Pending": "integer",
  "WorkflowStepId": "integer",
  "PreviousStepId": "string",
  "WorkflowId": "integer",
  "WorkflowStepTypeId": "string",
  "LogicStepId": "string",
  "IsInverseLogic": "boolean",
  "StepOptionsJson": "string",
  "WorkflowStepType": "string",
  "CachedDescription": "string",
  "IsActive": "boolean",
  "LogicChain": "string"
}

WorkflowStepTypeSelectModel: object

WorkflowStepTypeId: integer
Name: string
CachedDescription: string
Example
{
  "WorkflowStepTypeId": "integer",
  "Name": "string",
  "CachedDescription": "string"
}

WorkflowStepSelectModel: object

Id: integer
WorkflowStepId: integer
Order: integer
PreviousStepId: string
Name: string
Example
{
  "Id": "integer",
  "WorkflowStepId": "integer",
  "Order": "integer",
  "PreviousStepId": "string",
  "Name": "string"
}

Boolean: object

Example
"object"

StepPendingContactsModel: object

WorkflowStepId: integer
WorkflowId: integer
Contacts: string
Example
{
  "WorkflowStepId": "integer",
  "WorkflowId": "integer",
  "Contacts": "string"
}

HttpResponseMessage: object

Version: string
Content: string
StatusCode: string
ReasonPhrase: string
Headers: string
RequestMessage: string
IsSuccessStatusCode: boolean
Example
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}

ScoreboardDatapoint: object

Name: string
Value: string
Hint: string
Example
{
  "Name": "string",
  "Value": "string",
  "Hint": "string"
}

ChartData: object

series: string
data: string
extraStats: string
Example
{
  "series": "string",
  "data": "string",
  "extraStats": "string"
}
Documentation by Spectacle