up

Tag

Actions related to all cases of tags. A recipient can be tagged, but so can a link, a campaign, a mail, a datasource...

Get tag

The tag functionality is only a partial implementation at this moment. The foundation is, however, that anything (a link, a recipient, a mail, a segment etc) can be tagged with anything of your choice. This is useful when filtering and segmenting more personalized messages to your recipients. For instance, you may want to add a tag to a specific recipient when they purchase something on your website.

HTTP method: GET
http://api.sendcastle.com/v1/tag/[123]
http://api.sendcastle.com/v1/tag/[all]
cURL example
curl http://api.sendcastle.com/v1/tag/[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: 'tag.'":{
		"id":"1",
		"xxx"
	}
}
Other constraints:
  • Identifier can be an integer or 'all'
  • Requires read access
Change tag

The tag functionality is only a partial implementation at this moment. The foundation is, however, that anything (a link, a recipient, a mail, a segment etc) can be tagged with anything of your choice. This is useful when filtering and segmenting more personalized messages to your recipients. For instance, you may want to add a tag to a specific recipient when they purchase something on your website.

HTTP method: POST
http://api.sendcastle.com/v1/tag/[123]
cURL example
curl http://api.sendcastle.com/v1/tag/[123] \
	-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
  • No additional parameters required, unless stated elsewhere
  • No extra security requirements
  • Requires write access
  • VC_VRO
  • VC_VROCBZ
Create tag

The tag functionality is only a partial implementation at this moment. The foundation is, however, that anything (a link, a recipient, a mail, a segment etc) can be tagged with anything of your choice. This is useful when filtering and segmenting more personalized messages to your recipients. For instance, you may want to add a tag to a specific recipient when they purchase something on your website.

HTTP method: PUT
http://api.sendcastle.com/v1/tag/[123]
cURL example
curl http://api.sendcastle.com/v1/tag/[123] \
	--data '{"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:
  • Identifier should be an integer
  • Requires create access
  • Additional parameters required: name
Delete tag

The tag functionality is only a partial implementation at this moment. The foundation is, however, that anything (a link, a recipient, a mail, a segment etc) can be tagged with anything of your choice. This is useful when filtering and segmenting more personalized messages to your recipients. For instance, you may want to add a tag to a specific recipient when they purchase something on your website.

HTTP method: DELETE
http://api.sendcastle.com/v1/tag/[123]
http://api.sendcastle.com/v1/tag/[all]
cURL example
curl http://api.sendcastle.com/v1/tag/[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
Get tag alternatives

A tag can have a number of alternatives. For instance, the tag 'gender' may have the three options 'male', 'female' and 'unknown'. This method facilitates working with these alternatives.

HTTP method: GET
http://api.sendcastle.com/v1/tag/[xx]/alternatives/[yy]
cURL example
curl http://api.sendcastle.com/v1/tag/[xx]/alternatives/[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: 'tag.alternatives'":{
		"id":"1",
		"xxx"
	}
}
Other constraints:
  • Requires read access
Create tag alternatives

A tag can have a number of alternatives. For instance, the tag 'gender' may have the three options 'male', 'female' and 'unknown'. This method facilitates working with these alternatives.

HTTP method: PUT
http://api.sendcastle.com/v1/tag/[xx]/alternatives/[yy]
cURL example
curl http://api.sendcastle.com/v1/tag/[xx]/alternatives/[yy] \
	--data '{"tagid":"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:
  • Identifier should be an integer
  • Requires create access
  • Additional parameters required: tagid, name
Change tag alternatives

A tag can have a number of alternatives. For instance, the tag 'gender' may have the three options 'male', 'female' and 'unknown'. This method facilitates working with these alternatives.

HTTP method: POST
http://api.sendcastle.com/v1/tag/[xx]/alternatives/[yy]
cURL example
curl http://api.sendcastle.com/v1/tag/[xx]/alternatives/[yy] \
	--data '{"id":"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:
  • Parent identifier cannot be all
  • Requires write access
  • Additional parameters required: id
  • VC_VRONOIT
  • VC_VRO
Delete tag alternatives

A tag can have a number of alternatives. For instance, the tag 'gender' may have the three options 'male', 'female' and 'unknown'. This method facilitates working with these alternatives.

HTTP method: DELETE
http://api.sendcastle.com/v1/tag/[xx]/alternatives/[yy]
cURL example
curl http://api.sendcastle.com/v1/tag/[xx]/alternatives/[yy] \
	--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_VRONOIT
  • VC_VRO
Get tag'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/tag/[xx]/organize/[yy]
cURL example
curl http://api.sendcastle.com/v1/tag/[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: 'tag.organize'":{
		"id":"1",
		"xxx"
	}
}
Other constraints:
  • Requires read access
Change tag'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/tag/[xx]/organize/[yy]
cURL example
curl http://api.sendcastle.com/v1/tag/[xx]/organize/[yy] \
	--data '{"id":"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:
  • Parent identifier cannot be all
  • Requires write access
  • Additional parameters required: id
  • Parent identifier is primary identifier
  • VC_VRO
  • VC_VROCBZ
Create tag'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/tag/[xx]/organize/[yy]
cURL example
curl http://api.sendcastle.com/v1/tag/[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:
  • Parent identifier cannot be all
  • Requires create access
  • Additional parameters required: item, folder, sortorder