up

Recipient

Actions related to individual recipients.

Get recipient

Facilitates working with individual recipients in a datasource.

HTTP method: GET
http://api.sendcastle.com/v1/recipient/[123]
http://api.sendcastle.com/v1/recipient/[all]
cURL example
curl http://api.sendcastle.com/v1/recipient/[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: 'recipient.'":{
		"id":"1",
		"xxx"
	}
}
Other constraints:
  • Identifier can be an integer or 'all'
  • No additional parameters required, unless stated elsewhere
  • No extra security requirements
  • Requires read access
Create recipient

Facilitates working with individual recipients in a datasource.

HTTP method: PUT
http://api.sendcastle.com/v1/recipient/[123]
cURL example
curl http://api.sendcastle.com/v1/recipient/[123] \
	-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
  • No additional parameters required, unless stated elsewhere
  • No extra security requirements
  • Requires create access
Change recipient

Facilitates working with individual recipients in a datasource.

HTTP method: POST
http://api.sendcastle.com/v1/recipient/[123]
cURL example
curl http://api.sendcastle.com/v1/recipient/[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
Delete recipient

Facilitates working with individual recipients in a datasource.

HTTP method: DELETE
http://api.sendcastle.com/v1/recipient/[123]
cURL example
curl http://api.sendcastle.com/v1/recipient/[123] \
	-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 should be an integer
  • No additional parameters required, unless stated elsewhere
  • No extra security requirements
  • Requires delete access
get.recipient.resubscribe (!)

No description yet.

HTTP method: GET
http://api.sendcastle.com/v1/recipient/[xx]/resubscribe/[yy]
cURL example
curl http://api.sendcastle.com/v1/recipient/[xx]/resubscribe/[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: 'recipient.resubscribe'":{
		"id":"1",
		"xxx"
	}
}
Other constraints:
  • Parent identifier cannot be all
  • Parent identifier is primary identifier
  • No additional parameters required, unless stated elsewhere
  • No extra security requirements
  • Requires write access
  • VC_VRO