up

Field

Actions related to individual fields in the datasources.

Get field filter

There are a number of different filter types within SendCastle, one of them is the 'field filter' which lets you filter on data in your datasources; for instance 'name' or 'date of birth' if those fields were imported or requested in a form.

HTTP method: GET
http://api.sendcastle.com/v1/field/[str]
cURL example
curl http://api.sendcastle.com/v1/field/[str] \
	-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json"
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":{
		"UNKNOWN_RETURN_OBJECT: 'field.'":{
		"id":"1",
		"xxx"
	}
}
Other constraints:
  • Requires read access
Change field filter

There are a number of different filter types within SendCastle, one of them is the 'field filter' which lets you filter on data in your datasources; for instance 'name' or 'date of birth' if those fields were imported or requested in a form.

HTTP method: POST
http://api.sendcastle.com/v1/field/[str]
cURL example
curl http://api.sendcastle.com/v1/field/[str] \
	-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json" \ -X POST
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":true
}
Other constraints:
  • Requires write access
Create field filter

There are a number of different filter types within SendCastle, one of them is the 'field filter' which lets you filter on data in your datasources; for instance 'name' or 'date of birth' if those fields were imported or requested in a form.

HTTP method: PUT
http://api.sendcastle.com/v1/field/[str]
cURL example
curl http://api.sendcastle.com/v1/field/[str] \
	-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json" \ -X PUT
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":{
		"id":"1"
	}
}
Other constraints:
  • Requires create access
Delete field filter

There are a number of different filter types within SendCastle, one of them is the 'field filter' which lets you filter on data in your datasources; for instance 'name' or 'date of birth' if those fields were imported or requested in a form.

HTTP method: DELETE
http://api.sendcastle.com/v1/field/[str]
cURL example
curl http://api.sendcastle.com/v1/field/[str] \
	-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json" \ -X DELETE
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":true
}
Other constraints:
  • Requires delete access
Get field filter's organization properties

In SendCastle's UI you can organize messages, filters and datasources into folders and similar. This method facilitiates that functionality. It is probably of little use to external applications.

HTTP method: GET
http://api.sendcastle.com/v1/field/[xx]/organize/[yy]
cURL example
curl http://api.sendcastle.com/v1/field/[xx]/organize/[yy] \
	-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json"
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":{
		"UNKNOWN_RETURN_OBJECT: 'field.organize'":{
		"id":"1",
		"xxx"
	}
}
Other constraints:
  • Requires read access
Change field filter's organization properties

In SendCastle's UI you can organize messages, filters and datasources into folders and similar. This method facilitiates that functionality. It is probably of little use to external applications.

HTTP method: POST
http://api.sendcastle.com/v1/field/[xx]/organize/[yy]
cURL example
curl http://api.sendcastle.com/v1/field/[xx]/organize/[yy] \
	--data '{"id":"fnurt","organizableid":"fnurt"}' \
-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json" \ -X POST
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":true
}
Other constraints:
  • Requires write access
  • Additional parameters required: id, organizableid
  • Parent identifier is primary identifier
  • VC_VRO
  • VC_VROCBZ
Create field filter's organization properties

In SendCastle's UI you can organize messages, filters and datasources into folders and similar. This method facilitiates that functionality. It is probably of little use to external applications.

HTTP method: PUT
http://api.sendcastle.com/v1/field/[xx]/organize/[yy]
cURL example
curl http://api.sendcastle.com/v1/field/[xx]/organize/[yy] \
	--data '{"item":"fnurt","folder":"fnurt","sortorder":"fnurt"}' \
-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json" \ -X PUT
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":{
		"id":"1"
	}
}
Other constraints:
  • Requires create access
  • Additional parameters required: item, folder, sortorder