Glossary of terms v1.2

Attribute

A trait of a resource - comprised of a key and value pair.

Example: { name : "Hello world" }

API

'Application programming interface' - a protocol allowing two computerised systems to understand each other. Read more…

Associative array

An array of items with keys - items can be referenced using the key provided. Also see resource.

Example: { "attr":"val", "attr":"val" }

Boolean - bool

A binary variable, having two possible values called "true" and "false".

Bounce - hard bounce, soft bounce

A bounce occurs when a message cannot be delivered to a subscriber. Read more…

Confirmed opt-in

The process of someone providing their details, then having to manually confirm their subscription. This is usually done by clicking a link in a confirmation email. Read more…

Destination

A destination describes a shortcode or international format number used to receive SMS messages.

Do Not Contact list - DNC

An account specific suppression list which is checked against when adding or and importing subscribers. Subscribers can be added manually or will automatically be added when they unsubscribe.

Enumeration - enum

A complete listing of all possible values.

Filter - filtered, filtering

Constrain the number of results by supplying one or more attributes to match against.

Global Watch List - GWL

A Sign-Up.to maintained list of globally flagged email addresses, checked against when importing subscribers.

HTTP status

A sequence of numbers and text which describes the state of a response.

Example: HTTP/1.1 404 Not Found

Indexed array

An array of items without keys - items can be refenced using the incremental integer key. Also see collection.

Example: ["a", "b", "c", "d"]

Integer - int

A whole number; a number that is not a fraction.

Keyword

A string used as a unique identifier to route SMS messages to your account from the receiving destination.

Null

A data type which equates to having no value.

Permission marketing

The act of only sending marketing communications to individuals that have explicity given you permission to do so. Read more…

Primary list

The master list that is associated with a form. Optional secondary lists can also be associated.

POST

A RESTful method used for creating new resources. Generates a new id attribute which is used to itentify the resource in subsequent requests.

PUT

A RESTful method used for modifying existing resources. Often requires the id attribute to intentify the resource.

Recipient

The intended target of message; usually via "email" or "sms" channels.

Release - released, releasing

The act of publicly deploying a new version of the API (and supporting API reference).

Resource

An object which is unique to an endpoint; for example the 'list' resource is accessible via the 'list' endpoint. Each resource should be considered an associative array. Each of its keys are known as attributes with values.

REST - RESTful

A set of principles which guide the design of an API. In the case of our API, we employ the verbs available through the HTTP protocol. These verbs (GET, HEAD, POST, PUT and DELETE) describe the action you wish to perform on the given resource. Read more…

Request

The act of sending a request to the API using one of the supported RESTful methods.

Response

The response which is returned according to your request. Use HTTP status to determine the state of the response.

Sort - sorting, sorted, sortable

Sorting the response according to one or more sortable attributes in either ascending or descending order.

String

A variable consisting of a string of characters or no characters (empty string).

URI - URL

'Uniform Resource Identifier' - a string of characters used to identify a resource on the Internet.