KUkudosity
Contacts & Lists

Add List

Create New Contact List

post/add-list.json

Request

  • Base URL
    https://api.transmitsms.com
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

namestring required

A unique name for the list.

field_nstring

Custom field name. Firstname and lastname are created by default. There can be up to 10 extra custom fields. 'n' is an integer between 1 and 10.

response_style'array'

Indicates the response style. response_style = 'array' returns custom field lists as an array.

Example request

{
  "name": "MyList",
  "field_n": "email"
}

Response

Successful response

idstring

A unique identifier for the list.

namestring

Custom field name. Firstname and lastname are created by default. There can be up to 10 extra custom fields. 'n' is an integer between 1 and 10.

createdstring date-time

Date and time list was created. Returned in ISO8601 format YYYY-MM-DD HH:MM:SS in UTC Timezone.

members_activeinteger

Number of active members in the list. Always returns 0 for a new list.

fieldsstring[]

Names of created custom fields.

Example response

{
  "name": "email",
  "created": "2024-04-23T12:34:56Z",
  "fields": [
    "email",
    "phone"
  ],
  "errors": [
    {
      "CODE": "MISSING_PARAM",
      "HEADER": 400,
      "DESCRIPTION": "Field parameter is missing (eg. field_n)"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.