Reference

Subscribergroup

The subscribergroup object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this subscribergroup
AutoAddBookings: bool optional
AutoAddContacts: bool optional
AutoAddEvents: bool optional
AutoAddMembers: bool optional
AutoAddPayingMembers: bool optional
AutoAddVisitors: bool optional
BusinessId: Id required
Name: string required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this subscribergroup
SystemId: string optional api-only
User defined data about this subscribergroup. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "AutoAddBookings": false,
  "AutoAddContacts": false,
  "AutoAddEvents": false,
  "AutoAddMembers": false,
  "AutoAddPayingMembers": false,
  "AutoAddVisitors": false,
  "BusinessId": 12345678,
  "Name": "00001",
  "UniqueId": "f973a405-ae23-4de9-be8a-bd1fd3373b62",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a SubscriberGroup

This endpoint allows you to GET a list of subscribergroups based on one or more filter querystring parameters.

GET https://spaces.nexudus.com/api/content/subscribergroups?...

πŸ”’ Requires role "SubscriberGroup-List"

Pagination querystring parameters
Lets control how many records to return at a time and their order.
page integer optional
?page=1
size integer optional default=25
Sets the maximum number of records to return each page of results.
?size=25
orderby string optional default=Id
Sets the property to use when ordering the results of the search.
?orderby=Id
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records.
?sort=ascending

Search querystring parameters
Lets you search subscribergroup records based on their different properties.
Id number
?Id=12345678
SubscriberGroup_AutoAddBookings bool
?SubscriberGroup_AutoAddBookings=...
SubscriberGroup_AutoAddContacts bool
?SubscriberGroup_AutoAddContacts=...
SubscriberGroup_AutoAddEvents bool
?SubscriberGroup_AutoAddEvents=...
SubscriberGroup_AutoAddMembers bool
?SubscriberGroup_AutoAddMembers=...
SubscriberGroup_AutoAddPayingMembers bool
?SubscriberGroup_AutoAddPayingMembers=...
SubscriberGroup_AutoAddVisitors bool
?SubscriberGroup_AutoAddVisitors=...
SubscriberGroup_Business Business
?SubscriberGroup_Business=...
SubscriberGroup_Name string
?SubscriberGroup_Name=...
SubscriberGroup_BusinessName string
?SubscriberGroup_BusinessName=...
SubscriberGroup_NewsLetterSubscribers List of NewsLetterSubscriber
?SubscriberGroup_NewsLetterSubscribers=...

Range search querystring parameters
Lets you search subscribergroup records based on a range of date or numeric values.
To_SubscriberGroup_CreatedOn date
?To_SubscriberGroup_CreatedOn=2010-01-01T20:32
From_SubscriberGroup_CreatedOn date
?From_SubscriberGroup_CreatedOn=2010-01-01T20:32
To_SubscriberGroup_UpdatedOn date
?To_SubscriberGroup_UpdatedOn=2010-01-01T20:32
From_SubscriberGroup_UpdatedOn date
?From_SubscriberGroup_UpdatedOn=2010-01-01T20:32

Example request

GET https://spaces.nexudus.com/api/content/subscribergroups?SubscriberGroup_Name=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "00001",
        "AutoAddMembers": false,
        "AutoAddContacts": false,
        "AutoAddBookings": false,
        "AutoAddEvents": false,
        "AutoAddVisitors": false,
        "AutoAddPayingMembers": false,
        "SubscriberGroupBusinessName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "23cf68d4-9388-4ea3-84e7-51e2d09a9de9",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 25,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 60,
    "TotalPages": 3
}


Find SubscriberGroups by IDs

Gets one or more subscribergroup records based on their Id.
GET https://spaces.nexudus.com/api/content/subscribergroups?SubscriberGroup_Id=[:id1,:id2,...]

πŸ”’ Requires role "SubscriberGroup-List"

Querystring parameters
SubscriberGroup_Id: array requried
?SubscriberGroup_Id=[12345678,87654651]

Example request

GET https://spaces.nexudus.com/api/content/subscribergroups?SubscriberGroup_Id=[1234567,9876541]
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "00001",
        "AutoAddMembers": false,
        "AutoAddContacts": false,
        "AutoAddBookings": false,
        "AutoAddEvents": false,
        "AutoAddVisitors": false,
        "AutoAddPayingMembers": false,
        "SubscriberGroupBusinessName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "6ede1077-12c1-4eda-ab2a-c7d4c42b5f02",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}


Get single SubscriberGroup by Id

Gets one subscribergroup record by its Id.
GET https://spaces.nexudus.com/api/content/subscribergroups/:Id

πŸ”’ Requires role "SubscriberGroup-Read"

URL parameters
Id: number requried

Example request

GET https://spaces.nexudus.com/api/content/subscribergroups/1234567
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
  "Id": 1234567,
  "AutoAddBookings": false,
  "AutoAddContacts": false,
  "AutoAddEvents": false,
  "AutoAddMembers": false,
  "AutoAddPayingMembers": false,
  "AutoAddVisitors": false,
  "BusinessId": 12345678,
  "Name": "00001",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "7bd68b42-4e1e-41e2-b766-8766ad8b2aa6",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new SubscriberGroup

Creates a new subscribergroup.
POST https://spaces.nexudus.com/api/content/subscribergroups

πŸ”’ Requires role "SubscriberGroup-Create"

Body parameters
BusinessId: number required
Name: string required
AutoAddMembers: bool optional
AutoAddContacts: bool optional
AutoAddBookings: bool optional
AutoAddEvents: bool optional
AutoAddVisitors: bool optional
AutoAddPayingMembers: bool optional

Example request

POST https://spaces.nexudus.com/api/content/subscribergroups
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "BusinessId": 12345678,
    "Name": "00001",
    "NewsLetterSubscribers": [12345678, 87654321],
    "AutoAddMembers": false,
    "AutoAddContacts": false,
    "AutoAddBookings": false,
    "AutoAddEvents": false,
    "AutoAddVisitors": false,
    "AutoAddPayingMembers": false,
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully created.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Update SubscriberGroup

Updates an existing subscribergroup.
PUT https://spaces.nexudus.com/api/content/subscribergroups

PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.

πŸ”’ Requires role "SubscriberGroup-Edit"

Body parameters
Id: number required
The unique Id of the subscribergroup to update.
BusinessId: number cleared if missing
Name: string cleared if missing
AutoAddMembers: bool cleared if missing
AutoAddContacts: bool cleared if missing
AutoAddBookings: bool cleared if missing
AutoAddEvents: bool cleared if missing
AutoAddVisitors: bool cleared if missing
AutoAddPayingMembers: bool cleared if missing

Example request

PUT https://spaces.nexudus.com/api/content/subscribergroups
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "Name": "00001",
    "NewsLetterSubscribers": [12345678, 87654321],
    "AutoAddMembers": false,
    "AutoAddContacts": false,
    "AutoAddBookings": false,
    "AutoAddEvents": false,
    "AutoAddVisitors": false,
    "AutoAddPayingMembers": false,
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully updated.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Delete SubscriberGroup

Deletes an existing subscribergroup by its Id.
DELETE https://spaces.nexudus.com/api/content/subscribergroups/:Id

πŸ”’ Requires role "SubscriberGroup-Delete"

URL parameters
Id: number required
The unique Id of the subscribergroup to update.

Example request

DELETE https://spaces.nexudus.com/api/content/subscribergroups/12345678
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "The record was deleted successfully.",
    "Value": null,
    "OpenInDialog": false,
    "RedirectURL": null,
    "JavaScript": null,
    "Errors": null
}


Commands

Commands allow to perform actions against one or more subscribergroup records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.

Get Commands

Get all commands available to run for subscribergroup records.
GET https://spaces.nexudus.com/api/content/subscribergroups/commands

Example request

GET https://spaces.nexudus.com/api/content/subscribergroups/commands
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


[
	{
		"Key": "COMMAND_KEY_1",
		"Name": "Command 1 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": false,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": false,
		"NeedsEntitiesToRun": true,
		"Order": 2,
		"RequiresParameters": []
	},
	{
		"Key": "COMMAND_KEY_2",
		"Name": "Command 2 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": true,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": true,
		"NeedsEntitiesToRun": true,
		"Order": 10,
		"RequiresParameters": 
		[
			{
				"Name": "Parameter 1 description",
				"Type": "string",
			},
			{
				"Name": "Parameter 2 description",
				"Type": "Boolean",
			}
		]
	},
	...
]


Run Command

Runs a command based on its Key and one or more subscribergroup record IDs.
POST https://spaces.nexudus.com/api/content/subscribergroups/runacommand
πŸ”’ Requires role "SubscriberGroup-Edit"

Example request

POST https://spaces.nexudus.com/api/content/subscribergroups/runcommand
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
	"Ids":[1329961649],
	"Parameters": 
	[
		{ 
			"Type": "string"
			"Value":987654321
		},
		{
			"Type": "Boolean",
			"Value":true
		},
		...
	],
	"Key":"COMMAND_KEY_2"
}


Example valid response


{
	"Errors": null
	"JavaScript": null
	"Message": "Result description"
	"OpenInDialog": false
	"OpenInWindow": false
	"RedirectURL": null
	"Status": 200
	"UpdatedBy": "email@example.net"
	"UpdatedOn: "2020-06-04T11:40:20Z"
	"Value: {Id: 12345678}
	"WasSuccessful: true
}


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.