up

Organize

Sort of internal to the Sendcastle dashboard, it's used to organize objects visually in the campaign composer.

Get 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/organize/[123]
http://api.sendcastle.com/v1/organize/[all]
cURL example
curl http://api.sendcastle.com/v1/organize/[123] \
	-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: 'organize.'":{
		"id":"1",
		"xxx"
	}
}
Other constraints:
  • Identifier can be an integer or 'all'
  • Requires read access
Change 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/organize/[123]
cURL example
curl http://api.sendcastle.com/v1/organize/[123] \
	--data '{"name":"fnurt","objecttype":"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:
  • Identifier should be an integer
  • Additional parameters required: name, objecttype
  • Requires write access
  • VC_VRO
Create 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/organize/[str]
cURL example
curl http://api.sendcastle.com/v1/organize/[str] \
	--data '{"parent":"fnurt","sortorder":"fnurt","objecttype":"fnurt","name":"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:
  • Parent identifier cannot be all
  • Requires create access
  • Additional parameters required: parent, sortorder, objecttype, name
Delete 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: DELETE
http://api.sendcastle.com/v1/organize/[123]
http://api.sendcastle.com/v1/organize/[all]
cURL example
curl http://api.sendcastle.com/v1/organize/[123] \
	--data '{"id":"fnurt"}' \
-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:
  • Identifier can be an integer or 'all'
  • Requires delete access
  • Additional parameters required: id
  • VC_VRO