Subscriber Flex Exports

Create SubscriberFlexExported

Creates a new SubscriberFlexExported

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

groupID
required
string

Group ID

planID
required
string

Plan ID

calendarYear
required
string

Calendar Year

effectiveDate
required
string <date-time>

Effective Date

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
subscriberFlexExported_Key
required
integer <int32>

Unique identifier for each exported record being tracked as part of Flex integrations. Note: This field is marked as NOT NULL in the database and therefore required by the API.

calendar_Year
required
string [ 1 .. 4 ] characters

References SubscriberFlex.Calendar_Year value on the parent record.

effective_Date
required
string <date-time>

Date when the associated flex account becomes/became active. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

export_Amount
number or null <double>

The flex transaction amount sent for the associated integration.

export_Date
string or null <date-time>

Indicates the date that this record was exported for the identified type.

export_Status
string or null <= 32 characters

Custom value assigned by developer for the associated integration.

export_Type
string or null <= 32 characters

Custom value assigned by developer for the associated integration.

group_ID
required
string [ 1 .. 20 ] characters

References SubscriberFlex.Group_ID value on the parent record.

plan_ID
required
string [ 1 .. 20 ] characters

References SubscriberFlex.Plan_ID value on the parent record.

subscriber_ID
required
string [ 1 .. 9 ] characters

References SubscriberFlex.Subscriber_ID value on the parent record.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

Responses
200

Success

401

Unauthorized

post/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes/{calendarYear}/{effectiveDate}/exports
Request samples
{
  • "subscriberFlexExported_Key": 0,
  • "calendar_Year": "stri",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "export_Amount": 0.1,
  • "export_Date": "2019-08-24T14:15:22Z",
  • "export_Status": "string",
  • "export_Type": "string",
  • "group_ID": "string",
  • "plan_ID": "string",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SubscriberFlexExported

Lists all SubscriberFlexExported for the given subscriberID and groupID and planID and calendarYear and effectiveDate

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

groupID
required
string

Group ID

planID
required
string

Plan ID

calendarYear
required
string

Calendar Year

effectiveDate
required
string <date-time>

Effective Date

query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes/{calendarYear}/{effectiveDate}/exports
Request samples 
Response samples 
No sample
Get SubscriberFlexExported
Gets SubscriberFlexExported


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
planID
required
string
Plan ID


 
calendarYear
required
string
Calendar Year


 
effectiveDate
required
string <date-time> 
Effective Date


 
subscriberFlexExportedKey
required
integer <int32> 
SubscriberFlexExported Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes/{calendarYear}/{effectiveDate}/exports/{subscriberFlexExportedKey}
Request samples 
Response samples 
No sample
Update SubscriberFlexExported
Updates a specific SubscriberFlexExported.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
planID
required
string
Plan ID


 
calendarYear
required
string
Calendar Year


 
effectiveDate
required
string <date-time> 
Effective Date


 
subscriberFlexExportedKey
required
integer <int32> 
SubscriberFlexExported Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriberFlexExported_Key
required
integer <int32> 
Unique identifier for each exported record being tracked as part of Flex integrations. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
calendar_Year
required
string  [ 1 .. 4 ] characters 
References SubscriberFlex.Calendar_Year value on the parent record.


 
effective_Date
required
string <date-time> 
Date when the associated flex account becomes/became active. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
export_Amount
number or null <double> 
The flex transaction amount sent for the associated integration.


 
export_Date
string or null <date-time> 
Indicates the date that this record was exported for the identified type.


 
export_Status
string or null  <= 32 characters 
Custom value assigned by developer for the associated integration.


 
export_Type
string or null  <= 32 characters 
Custom value assigned by developer for the associated integration.


 
group_ID
required
string  [ 1 .. 20 ] characters 
References SubscriberFlex.Group_ID value on the parent record.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
References SubscriberFlex.Plan_ID value on the parent record.


 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References SubscriberFlex.Subscriber_ID value on the parent record.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
Responses 
200
Success


401
Unauthorized


put/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes/{calendarYear}/{effectiveDate}/exports/{subscriberFlexExportedKey}
Request samples 
{
  • "subscriberFlexExported_Key": 0,
  • "calendar_Year": "stri",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "export_Amount": 0.1,
  • "export_Date": "2019-08-24T14:15:22Z",
  • "export_Status": "string",
  • "export_Type": "string",
  • "group_ID": "string",
  • "plan_ID": "string",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SubscriberFlexExported
Deletes an SubscriberFlexExported


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
planID
required
string
Plan ID


 
calendarYear
required
string
Calendar Year


 
effectiveDate
required
string <date-time> 
Effective Date


 
subscriberFlexExportedKey
required
integer <int32> 
SubscriberFlexExported Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes/{calendarYear}/{effectiveDate}/exports/{subscriberFlexExportedKey}
Request samples 
Create or Update Batch SubscriberFlexExported
Create or Update multiple SubscriberFlexExported at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
planID
required
string
Plan ID


 
calendarYear
required
string
Calendar Year


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
subscriberFlexExported_Key
required
integer <int32> 
Unique identifier for each exported record being tracked as part of Flex integrations. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
calendar_Year
required
string  [ 1 .. 4 ] characters 
References SubscriberFlex.Calendar_Year value on the parent record.


 
effective_Date
required
string <date-time> 
Date when the associated flex account becomes/became active. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
export_Amount
number or null <double> 
The flex transaction amount sent for the associated integration.


 
export_Date
string or null <date-time> 
Indicates the date that this record was exported for the identified type.


 
export_Status
string or null  <= 32 characters 
Custom value assigned by developer for the associated integration.


 
export_Type
string or null  <= 32 characters 
Custom value assigned by developer for the associated integration.


 
group_ID
required
string  [ 1 .. 20 ] characters 
References SubscriberFlex.Group_ID value on the parent record.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
References SubscriberFlex.Plan_ID value on the parent record.


 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References SubscriberFlex.Subscriber_ID value on the parent record.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
Responses 
207
Success


401
Unauthorized


put/subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes/{calendarYear}/{effectiveDate}/exports-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}