REST Email Marketing API Documentation

OfflineEvents -— Create

Create a new Offline Event.

HTTP VERB

Post

URL

/API/Rest/OfflineEvents

ARGUMENTS

name The name of the new Offline Event. 25 characters or less.
Description (Optional) A description of the Offline Event, for your use. 500 characters or less
columns An array of data about the columns in the Offline Event, made up of the following fields:
name The name of the column
description (Optional) An optional description of the column
columnType The datatype of the column
allowNull (Boolean) Should the column allow null values?

Required permission

CreateOfflineEvent

ERRORS

No Permission
Invalid offline event name
Invalid description
Invalid column definitions
Invalid column name
Duplicate column name
Invalid datatype
Duplicate offline event name
Too many API calls
Database error
Unknown error

RETURNS

Success


EXAMPLE

Create an offline event.


string message = "{'accountName':'acme','login':'ApiUser', 'password':'sdve4t3gfd', 'name':'Whitepaper download', 'description':'Keep track of the white papers they view', 'columns':[{'name':'Download name', 'description':'The name of the download', 'columnType':'String25', 'allowNull':false}, {'name':'Subject area', 'description':'The subject area of the download', 'columnType':'String50', 'allowNull':false}]}";
string url = "http://example.com/api/rest/OfflineEvents";
								
try
{
	System.Net.HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
	request.Method = "POST";
	request.ContentType = "application/json";
	request.ContentLength = message.Length;
	using (Stream webStream = request.GetRequestStream())
		using (StreamWriter requestWriter = new StreamWriter(webStream, System.Text.Encoding.ASCII))
			requestWriter.Write(message);
								
	System.Net.WebResponse webResponse = request.GetResponse();
	using (Stream webStream = webResponse.GetResponseStream())
		using (StreamReader responseReader = new StreamReader(webStream))
			Console.Out.WriteLine(responseReader.ReadToEnd());
}
catch (Exception e)
{
	System.Diagnostics.Debug.Fail(e.Message);
}
							
# encoding: utf-8
require 'rest-client'
require 'json'
							
url = 'http://www.acme.com/api/rest/OfflineEvents'
args = {'accountName'=>'acme', 'login'=>'ApiUser', 'password'=>'sdf3w4tw', 'name'=>'Whitepaper download', 'description'=>'Keep track of the white papers they view', 'columns'=>[{'name'=>'Download name', 'description'=>'The name of the download', 'columnType'=>'String25', 'allowNull'=>false}, {'name'=>'Subject area', 'description'=>'The subject area of the download', 'columnType'=>'String50', 'allowNull'=>false}]}
response = RestClient.post(url, args.to_json, :content_type => "application/json;charset=utf-8")
puts response	
						
import requests

url = "http://www.example.com/api/rest/OfflineEvents";
args = {'accountName':'acme','login':'ApiUser', 'password':'f334f3fg3', 'name':'Whitepaper download', 'description':'Keep track of the white papers they view', 'columns':[{'name':'Download name', 'description':'The name of the download', 'columnType':'String25', 'allowNull':false}, {'name':'Subject area', 'description':'The subject area of the download', 'columnType':'String50', 'allowNull':false}]}
headers = {'Content-Type': 'application/json'}
resp = requests.post(url, json=args, headers=headers)
if resp.status_code == 200:
	print resp.text
						

curl -X POST -H "Content-Type: application/json" -d "{'accountName':'acme','login':'ApiUser', 'password':'f334f3fg3', 'name':'Whitepaper download', 'description':'Keep track of the white papers they view', 'columns':[{'name':'Download name', 'description':'The name of the download', 'columnType':'String25', 'allowNull':False}, {'name':'Subject area', 'description':'The subject area of the download', 'columnType':'String50', 'allowNull':False}]}" http://www.example.com/API/Rest/OfflineEvents

As a user of Goolara Symphonie, the REST API is free and included in the latest version of the software. If you have any questions about using Symphonie’s REST API, feel free to contact us.