Business Messenger CDS API

1. Introduction

The Business Messenger Customer Data Storage (BM CDS) API is a standard REST HTTP API with JSON payload. It can be used to store customer subscription information, create messaging lists etc. The BM API authorization is implemented as the industry-standard OAuth 2.0 protocol. For more information, please refer to the OAuth2 Authentication Guidelines.

API Call examples

The following sample CURL call adds a new contact in your BM account:

curl -X POST --header "Content-Type: application/json" --header "Accept: application/json" --header "Authorization: Bearer ACCESS_TOKEN" -d "{
    \"list_uuid\": \"LIST_UUID\",
    \"first_name\": \"John\",
    \"last_name\": \"Smith\",
    \"mobile\": \"+12025550100\",
    \"email\": \"john@example.com\",
    \"address\": \"St One\",
    \"zip\": \"9000\",
    \"city\": \"NY\",
    \"country\": \"US\"
  }" "https://api.horisen.pro/news/v1/services/SERVICE_UUID/cds/contacts"

An example call searching for contact(s) with +11111111111 mobile number:

curl --header "Accept: application/json" --header "Authorization: Bearer ACCESS_TOKEN" "https://api.horisen.pro/news/v1/services/SERVICE_UUID/cds/contacts?mobile=%2B11111111111"

If you need a batch import of contacts, an example of how to do that is given below:

curl -X POST "https://api.horisen.pro/news/v1/services/SERVICE_UUID/cds/imports?list_uuid=LIST_UUID&resolve_duplicate=update&identifier=mobile" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -d @- << EOF
  [
    {"mobile":"+41765554366","first_name":"John","last_name":"Smith"},
    {"mobile":"+41765554783","first_name":"Mike","last_name":"Collins"},
    {"mobile":"+41775559513","first_name":"George","last_name":"Davis"}
  ]
  EOF

identifier=mobile defines that new and existing contacts will be mapped by the mobile property.
resolve_duplicate=update instructs what to do with duplicate records (in this case, updates the old record with the new data).

2. Methods Overview

2.1 Contact

Endpoints for Contacts Management.

GET/services/{serviceUuid}/cds/contacts
Returns a list of contacts.Read More
POST/services/{serviceUuid}/cds/contacts
Creates a new Contact.Read More
GET/services/{serviceUuid}/cds/contacts/{contactId}
Returns a Contact by UUID.Read More
PUT/services/{serviceUuid}/cds/contacts/{contactId}
Updates a Contact by UUID.Read More
PATCH/services/{serviceUuid}/cds/contacts/{contactId}
Patches a Contact by UUID.Read More
DELETE/services/{serviceUuid}/cds/contacts/{contactId}
Deletes a Contact by UUID.Read More
POST/services/{serviceUuid}/cds/imports
Imports contacts in a batch.Read More

2.2 List

Endpoints for Lists Management.

GET/services/{serviceUuid}/cds/lists
Returns an array of Lists.Read More
POST/services/{serviceUuid}/cds/lists
Creates a new List.Read More
GET/services/{serviceUuid}/cds/lists/{listId}
Returns a list by UUID.Read More
PUT/services/{serviceUuid}/cds/lists/{listId}
Updates a List.Read More
DELETE/services/{serviceUuid}/cds/lists/{listId}
Deletes a List.Read More

2.3 Field

Endpoints for Contact Fields Management.

GET/services/{serviceUuid}/cds/fields
Returns a list of Contact Fields.Read More
GET/services/{serviceUuid}/cds/custom_fields
Returns a list of Custom Fields.Read More
POST/services/{serviceUuid}/cds/custom_fields
Creates a Custom Field.Read More
GET/services/{serviceUuid}/cds/custom_fields/{customFieldsId}
Returns a Custom Field by UUID.Read More
PUT/services/{serviceUuid}/cds/custom_fields/{customFieldsId}
Updates a Custom Field.Read More
DELETE/services/{serviceUuid}/cds/custom_fields/{customFieldsId}
Deletes a Custom Field.Read More

2.4 Segmentation

Endpoints for Segmentation Sets and Groups Management.

GET/services/{serviceUuid}/cds/segmentation_sets
Returns a list of Segmentation Sets.Read More
POST/services/{serviceUuid}/cds/segmentation_sets
Creates a new Segmentation Set.Read More
GET/services/{serviceUuid}/cds/segmentation_sets/{segmentationSetId}
Returns a Segmentation Set by UUID.Read More
PUT/services/{serviceUuid}/cds/segmentation_sets/{segmentationSetId}
Updates a Segmentation Set.Read More
DELETE/services/{serviceUuid}/cds/segmentation_sets/{segmentationSetId}
Deletes a Segmentation Set.Read More
GET/services/{serviceUuid}/cds/segmentation_groups
Returns a list of Segmentation Groups.Read More
POST/services/{serviceUuid}/cds/segmentation_groups
Creates a Segmentation Group.Read More
GET/services/{serviceUuid}/cds/segmentation_groups/{segmentationGroupId}
Returns a Segmentation Group by UUID.Read More
PUT/services/{serviceUuid}/cds/segmentation_groups/{segmentationGroupId}
Updates a Segmentation Group.Read More
DELETE/services/{serviceUuid}/cds/segmentation_groups/{segmentationGroupId}
Deletes a Segmentation Group Set.Read More

2.5 Subscription

Endpoints for Subscriptions and Options Management.

GET/services/{serviceUuid}/cds/subscriptions
Returns a list of Subscriptions.Read More
POST/services/{serviceUuid}/cds/subscriptions
Creates a new Subscription.Read More
GET/services/{serviceUuid}/cds/subscriptions/{subscriptionId}
Returns a Subscription by UUID.Read More
PUT/services/{serviceUuid}/cds/subscriptions/{subscriptionId}
Updates a Subscription.Read More
DELETE/services/{serviceUuid}/cds/subscriptions/{subscriptionId}
Deletes a Subscription.Read More
GET/services/{serviceUuid}/cds/subscriptions/options
Returns a list of Subscription Options.Read More
POST/services/{serviceUuid}/cds/subscriptions/options
Creates a Subscription Options.Read More
GET/services/{serviceUuid}/cds/subscriptions/options/{optionId}
Returns a Subscription Option by UUID.Read More
PUT/services/{serviceUuid}/cds/subscriptions/options/{optionId}
Updates a Subscription Option.Read More
DELETE/services/{serviceUuid}/cds/subscriptions/options/{optionId}
Deletes a Subscription Option.Read More
GET/services/{serviceUuid}/cds/subscriptions/members
Returns a list of a Subscription Option Members.Read More
POST/services/{serviceUuid}/cds/subscriptions/members
Creates or Updates a Subscription Member.Read More

2.6 Group

Endpoints for Groups Management.

GET/services/{serviceUuid}/cds/groups
Returns a list of Groups.Read More
POST/services/{serviceUuid}/cds/groups
Creates a new Group.Read More
GET/services/{serviceUuid}/cds/groups/{groupId}
Returns a Group by UUID.Read More
PUT/services/{serviceUuid}/cds/groups/{groupId}
Updates a Group.Read More
DELETE/services/{serviceUuid}/cds/groups/{groupId}
Deletes a Group.Read More
GET/services/{serviceUuid}/cds/group_lists
Returns a list of Group Lists.Read More
POST/services/{serviceUuid}/cds/group_lists
Creates a Group List.Read More
GET/services/{serviceUuid}/cds/group_lists/{groupListId}
Returns a Group List by UUID.Read More
PUT/services/{serviceUuid}/cds/group_lists/{groupListId}
Updates a Group List.Read More
GET/services/{serviceUuid}/cds/group_segmentation
Returns a list of Group Segmentations.Read More
POST/services/{serviceUuid}/cds/group_segmentation
Creates a new Group Segmentation.Read More
GET/services/{serviceUuid}/cds/group_segmentation/{groupSegmentationId}
Gets a Group Segmentation by UUID.Read More
PUT/services/{serviceUuid}/cds/group_segmentation/{groupSegmentationId}
Updates a Group Segmentation.Read More

2.7 Touchpoint

Endpoints for Touchpoints Management.

GET/services/{serviceUuid}/cds/touchpoints
Returns a list of Touchpoints.Read More
POST/services/{serviceUuid}/cds/touchpoints
Creates a new Touchpoint.Read More
GET/services/{serviceUuid}/cds/touchpoints/{touchpointId}
Returns a Touchpoint by UUID.Read More
PUT/services/{serviceUuid}/cds/touchpoints/{touchpointId}
Updates a Touchpoint.Read More
DELETE/services/{serviceUuid}/cds/touchpoints/{touchpointId}
Deletes a Touchpoint.Read More
GET/services/{serviceUuid}/cds/touchpoints/members
Returns a list of Touchpoint Members.Read More
POST/services/{serviceUuid}/cds/touchpoints/members
Creates or Updates a Touchpoint Membership.Read More

2.8 Interest

Endpoints for Interests Management.

GET/services/{serviceUuid}/cds/interests
Returns a list of Interests.Read More
POST/services/{serviceUuid}/cds/interests
Creates a new Interest.Read More
GET/services/{serviceUuid}/cds/interests/{interestId}
Gets an Interest by UUID.Read More
PUT/services/{serviceUuid}/cds/interests/{interestId}
Updates an Interest.Read More
DELETE/services/{serviceUuid}/cds/interests/{interestId}
Deletes an Interest.Read More
GET/services/{serviceUuid}/cds/interests/members
Returns a list of Interest Members.Read More
POST/services/{serviceUuid}/cds/interests/members
Creates or Updates an Interest Member.Read More

3. Methods Details

3.1 Contact

Endpoints for Contacts Management.

GET/services/{serviceUuid}/cds/contacts
Returns a list of contacts.Up

Method Overview

Returns a list of contacts.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
fields array[string] (query) Optional fields (lists, show_deleted, count_only).
Available values : lists, count_only.
list_uuids array[string] (query) List UUIDs (comma-separated).
subscription_uuids array[string] (query) Subscription Options UUIDs (comma-separated).
interest_uuids array[string] (query) Interest UUIDs (comma-separated).
touchpoint_uuids array[string] (query) Touchpoint UUIDs (comma-separated).
member_status string (query) Member status ('subscribed', 'unsubscribed').
subscription_status string (query) Subscription member status ('subscribed', 'unsubscribed').
opt_status string (query) Opt status (in, out).
opt_status_webpush string (query) Opt status webpush (in, out).
gender string (query) Gender ('male', 'female').
mobile string (query) Mobile (E.164 with + prefix).
email string (query) Email.
webpush_subscription string (query) Webpush subscription.
first_name string (query) First Name.
last_name string (query) Last Name.
age string (query) Age.
query string (query) Segmentation.
group_uuid string (query) Group UUID.
page_number integer (query) Page number. The default value: 1.
page_size integer (query) Page size. The default value: 10.
sort string (query) Sort order for the result records.
Available values: mobile, -mobile, first_name, -first_name, last_name, -last_name, created_dt, -created_dt, birthday, -birthday, gender, -gender, updated_dt, -updated_dt.
required array[string] (query) Returns contacts which have these fields defined: 'mobile', 'email', 'birthday', 'first_name', 'last_name'.
Available values: mobile, email, birthday, first_name, last_name.
updated_dt string (query) The date/time when the content was updated. It is in rfc3339 format. You can use operators for this field, e.g. gt(updated_dt)=2020-03-01T09:21:11+00:00 to get all contacts updated after the specified time.

Success Response 200: List of Contacts

{
  "data": [
    {
      "uuid": "string",
      "created_dt": "string",
      "updated_dt": "string",
      "list_uuid": "string",
      "first_name": "string",
      "last_name": "string",
      "second_name": "string",
      "nick_name": "string",
      "gender": "string",
      "birthday": "string",
      "salutation": "string",
      "title": "string",
      "language": "string",
      "nationality": "string",
      "mobile": "string",
      "email": "string",
      "phone": "string",
      "address": "string",
      "zip": "string",
      "city": "string",
      "region": "string",
      "country": "string",
      "b_mobile": "string",
      "b_email": "string",
      "b_phone": "string",
      "b_address": "string",
      "b_zip": "string",
      "b_city": "string",
      "b_region": "string",
      "b_country": "string",
      "b_job_title": "string",
      "b_department": "string",
      "b_reception_code": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "perPage": 0,
      "currentPage": 0,
      "totalPages": 0,
      "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
      }
    }
  }
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
POST/services/{serviceUuid}/cds/contacts
Creates a new Contact.Up

Method Overview

Creates a new Contact.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
body (required) (body) Contact data.

Data Parameters

Contact data object example

{
  "list_uuid": "string",
  "first_name": "string",
  "last_name": "string",
  "second_name": "string",
  "nick_name": "string",
  "gender": "string",
  "birthday": "string",
  "salutation": "string",
  "title": "string",
  "language": "string",
  "nationality": "string",
  "mobile": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "zip": "string",
  "city": "string",
  "region": "string",
  "country": "string",
  "b_mobile": "string",
  "b_email": "string",
  "b_phone": "string",
  "b_address": "string",
  "b_zip": "string",
  "b_city": "string",
  "b_region": "string",
  "b_country": "string",
  "b_job_title": "string",
  "b_department": "string",
  "b_reception_code": "string"
}

Success Response 201: Created Contact

{
  "uuid": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "list_uuid": "string",
  "first_name": "string",
  "last_name": "string",
  "second_name": "string",
  "nick_name": "string",
  "gender": "string",
  "birthday": "string",
  "salutation": "string",
  "title": "string",
  "language": "string",
  "nationality": "string",
  "mobile": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "zip": "string",
  "city": "string",
  "region": "string",
  "country": "string",
  "b_mobile": "string",
  "b_email": "string",
  "b_phone": "string",
  "b_address": "string",
  "b_zip": "string",
  "b_city": "string",
  "b_region": "string",
  "b_country": "string",
  "b_job_title": "string",
  "b_department": "string",
  "b_reception_code": "string"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
GET/services/{serviceUuid}/cds/contacts/{contactId}
Returns a Contact by UUID.Up

Method Overview

Returns a Contact by UUID.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
contactId (required) string (path) The ID of a Contact to get.
fields array[string] (query) Optional fields (lists).

Success Response 200: Contact Data

{
  "uuid": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "list_uuid": "string",
  "first_name": "string",
  "last_name": "string",
  "second_name": "string",
  "nick_name": "string",
  "gender": "string",
  "birthday": "string",
  "salutation": "string",
  "title": "string",
  "language": "string",
  "nationality": "string",
  "mobile": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "zip": "string",
  "city": "string",
  "region": "string",
  "country": "string",
  "b_mobile": "string",
  "b_email": "string",
  "b_phone": "string",
  "b_address": "string",
  "b_zip": "string",
  "b_city": "string",
  "b_region": "string",
  "b_country": "string",
  "b_job_title": "string",
  "b_department": "string",
  "b_reception_code": "string"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
PUT/services/{serviceUuid}/cds/contacts/{contactId}
Updates a Contact by UUID.Up

Method Overview

Updates a Contact by UUID.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
contactId (required) string (path) ID of a Contact to update.
body (required) (body) Contact data.

Data Parameters

Contact data object example

{
  "list_uuid": "string",
  "first_name": "string",
  "last_name": "string",
  "second_name": "string",
  "nick_name": "string",
  "gender": "string",
  "birthday": "string",
  "salutation": "string",
  "title": "string",
  "language": "string",
  "nationality": "string",
  "mobile": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "zip": "string",
  "city": "string",
  "region": "string",
  "country": "string",
  "b_mobile": "string",
  "b_email": "string",
  "b_phone": "string",
  "b_address": "string",
  "b_zip": "string",
  "b_city": "string",
  "b_region": "string",
  "b_country": "string",
  "b_job_title": "string",
  "b_department": "string",
  "b_reception_code": "string"
}

Success Response 200: Contact Data

{
  "uuid": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "list_uuid": "string",
  "first_name": "string",
  "last_name": "string",
  "second_name": "string",
  "nick_name": "string",
  "gender": "string",
  "birthday": "string",
  "salutation": "string",
  "title": "string",
  "language": "string",
  "nationality": "string",
  "mobile": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "zip": "string",
  "city": "string",
  "region": "string",
  "country": "string",
  "b_mobile": "string",
  "b_email": "string",
  "b_phone": "string",
  "b_address": "string",
  "b_zip": "string",
  "b_city": "string",
  "b_region": "string",
  "b_country": "string",
  "b_job_title": "string",
  "b_department": "string",
  "b_reception_code": "string"
}

Error Response 400: Invalid request

Error Response 404: Resource not found

Error Response 405: Validation exception

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
PATCH/services/{serviceUuid}/cds/contacts/{contactId}
Patches a Contact by UUID.Up

Method Overview

Patches a Contact by UUID.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
contactId (required) string (path) Contact ID to update.
body (required) (body) Contact Status.

Data Parameters

Contact Status object example

{
  "opt_status": "string"
}

Success Response 200: Contact Data

{
  "uuid": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "list_uuid": "string",
  "first_name": "string",
  "last_name": "string",
  "second_name": "string",
  "nick_name": "string",
  "gender": "string",
  "birthday": "string",
  "salutation": "string",
  "title": "string",
  "language": "string",
  "nationality": "string",
  "mobile": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "zip": "string",
  "city": "string",
  "region": "string",
  "country": "string",
  "b_mobile": "string",
  "b_email": "string",
  "b_phone": "string",
  "b_address": "string",
  "b_zip": "string",
  "b_city": "string",
  "b_region": "string",
  "b_country": "string",
  "b_job_title": "string",
  "b_department": "string",
  "b_reception_code": "string"
}

Error Response 400: Invalid request

Error Response 404: Resource not found

Error Response 405: Validation exception

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
DELETE/services/{serviceUuid}/cds/contacts/{contactId}
Deletes a Contact by UUID.Up

Method Overview

Deletes a Contact by UUID.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
contactId (required) string (path) Contact ID to delete.
gdpr string (query) If full GDPR delete should be executed.
Available values: yes, no.
Default value: no.

Success Response 204: Contact Deleted

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
POST/services/{serviceUuid}/cds/imports
Imports contacts in a batch.Up

Method Overview

Imports contacts in a batch.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
list_uuid (required) string (query) UUID of a list in which contacts should be imported.
option_uuids array[string] (query) A comma separated string of subscription option UUIDs.
touchpoint_uuids array[string] (query) A comma separated string of touchpoint UUIDs.
interest_uuids array[string] (query) A comma separated string of interest UUIDs.
resolve_duplicate (required) string (query) Defines an action how to resolve found duplicates (update, skip, unsubscribe, delete).
Available values: update, skip, unsubscribe, delete.
The default value: update.
identifier (required) string (query) This field is to be used as a unique identifier of imported contacts.
The default value: mobile.
body (required) array (body) Array of Contacts to add.

Data Parameters

Contacts Array body object example

[
  {
    "list_uuid": "string",
    "first_name": "string",
    "last_name": "string",
    "second_name": "string",
    "nick_name": "string",
    "gender": "string",
    "birthday": "string",
    "salutation": "string",
    "title": "string",
    "language": "string",
    "nationality": "string",
    "mobile": "string",
    "email": "string",
    "phone": "string",
    "address": "string",
    "zip": "string",
    "city": "string",
    "region": "string",
    "country": "string",
    "b_mobile": "string",
    "b_email": "string",
    "b_phone": "string",
    "b_address": "string",
    "b_zip": "string",
    "b_city": "string",
    "b_region": "string",
    "b_country": "string",
    "b_job_title": "string",
    "b_department": "string",
    "b_reception_code": "string"
  }
]

Success Response 200: Import result

{
  "created": 0,
  "deleted": 0,
  "invalid": 0,
  "updated": 0,
  "skipped": 0,
  "errors": [
    {
      "contact": {
        "uuid": "string",
        "created_dt": "string",
        "updated_dt": "string",
        "list_uuid": "string",
        "first_name": "string",
        "last_name": "string",
        "second_name": "string",
        "nick_name": "string",
        "gender": "string",
        "birthday": "string",
        "salutation": "string",
        "title": "string",
        "language": "string",
        "nationality": "string",
        "mobile": "string",
        "email": "string",
        "phone": "string",
        "address": "string",
        "zip": "string",
        "city": "string",
        "region": "string",
        "country": "string",
        "b_mobile": "string",
        "b_email": "string",
        "b_phone": "string",
        "b_address": "string",
        "b_zip": "string",
        "b_city": "string",
        "b_region": "string",
        "b_country": "string",
        "b_job_title": "string",
        "b_department": "string",
        "b_reception_code": "string"
      },
      "errors": [
        {
          "name": "string",
          "message": "string",
          "description": "string"
        }
      ]
    }
  ]
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}

3.2 List

Endpoints for Lists Management.

GET/services/{serviceUuid}/cds/lists
Returns an array of Lists.Up

Method Overview

Returns an array of Lists.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
fields array[string] (query) Optional fields (totals, status, show_deleted, contacts_count).

Success Response 200: Array of Lists

{
  "data": [
    {
      "uuid": "string",
      "name": "string",
      "list_status": "string",
      "created_dt": "string",
      "updated_dt": "string",
      "subscribed": 0,
      "unsubscribed": 0,
      "contacts_count": 0
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "perPage": 0,
      "currentPage": 0,
      "totalPages": 0,
      "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
      }
    }
  }
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
POST/services/{serviceUuid}/cds/lists
Creates a new List.Up

Method Overview

Creates a new List.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
body (required) (body) List to add.

Data Parameters

List body object example

{
  "uuid": "string",
  "name": "string",
  "list_status": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "subscribed": 0,
  "unsubscribed": 0,
  "contacts_count": 0
}

Success Response 201: New List response

{
  "uuid": "string",
  "name": "string",
  "list_status": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "subscribed": 0,
  "unsubscribed": 0,
  "contacts_count": 0
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
GET/services/{serviceUuid}/cds/lists/{listId}
Returns a List by UUID.Up

Method Overview

Returns a List by UUID.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
listId (required) string (path) The ID of a List to get.

Success Response 200: List Data

{
  "uuid": "string",
  "name": "string",
  "list_status": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "subscribed": 0,
  "unsubscribed": 0,
  "contacts_count": 0
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
PUT/services/{serviceUuid}/cds/lists/{listId}
Updates a List.Up

Method Overview

Updates a List.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
listId (required) string (path) ID of a List to update.
body (required) (body) List data.

Data Parameters

List data object example

{
  "uuid": "string",
  "name": "string",
  "list_status": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "subscribed": 0,
  "unsubscribed": 0,
  "contacts_count": 0
}

Success Response 200: Resource updated

Error Response 400: Invalid request

Error Response 404: Resource not found

Error Response 405: Validation exception

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
DELETE/services/{serviceUuid}/cds/lists/{listId}
Deletes a List by UUID.Up

Method Overview

Deletes a List by UUID.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
listId (required) string (path) List ID.

Success Response 204: List Deleted

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}

3.3 Field

Endpoints for Contact Fields Management.

GET/services/{serviceUuid}/cds/fields
Returns a list of Contact Fields.Up

Method Overview

Returns a list of Contact Fields.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
include_all string (query) Appends custom fields and returns more detailed information about fields (use value 1 to set it).
Default value: 1.

Success Response 200: List of all fields

[
  {
    "display_name": "string",
    "field_type": "string",
    "field_name": "string",
    "mandatory": "no",
    "order_num": 0,
    "config": {},
    "identifier": "no"
  }
]

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
GET/services/{serviceUuid}/cds/custom_fields
Returns a list of Custom Fields.Up

Method Overview

Returns a list of Custom Fields.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.

Success Response 200: List of Custom Fields

{
  "data": [
    {
      "display_name": "string",
      "field_type": "string",
      "field_name": "string",
      "mandatory": "no",
      "order_num": 0,
      "config": {},
      "identifier": "no"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "perPage": 0,
      "currentPage": 0,
      "totalPages": 0,
      "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
      }
    }
  }
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
POST/services/{serviceUuid}/cds/custom_fields
Creates a Custom Field.Up

Method Overview

Creates a Custom Field.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
body (required) (body) Field data.

Data Parameters

Field body object example

{
  "display_name": "string",
  "field_type": "string",
  "field_name": "string",
  "mandatory": "no",
  "order_num": 0,
  "config": {},
  "identifier": "no"
}

Success Response 201: New Custom field response

{
  "display_name": "string",
  "field_type": "string",
  "field_name": "string",
  "mandatory": "no",
  "order_num": 0,
  "config": {},
  "identifier": "no"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
GET/services/{serviceUuid}/cds/custom_fields/{customFieldsId}
Returns a Custom Field by UUID.Up

Method Overview

Returns a Custom Field by UUID.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
customFieldId (required) string (path) The ID of a Custom Field to get.

Success Response 200: Custom Field Data

{
  "display_name": "string",
  "field_type": "string",
  "field_name": "string",
  "mandatory": "no",
  "order_num": 0,
  "config": {},
  "identifier": "no"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
PUT/services/{serviceUuid}/cds/custom_fields/{customFieldsId}
Updates a Custom Field.Up

Method Overview

Updates a Custom Field.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
customFieldID (required) string (path) ID of a Custom Field to update.
body (required) (body) Custom Field data.

Data Parameters

Custom Field data object example

{
  "display_name": "string",
  "field_type": "string",
  "field_name": "string",
  "mandatory": "no",
  "order_num": 0,
  "config": {},
  "identifier": "no"
}

Success Response 200: Resource updated

Error Response 400: Invalid request

Error Response 404: Resource not found

Error Response 405: Validation exception

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
DELETE/services/{serviceUuid}/cds/custom_fields/{customFieldsId}
Deletes a Custom Field by UUID.Up

Method Overview

Deletes a Custom Field by UUID.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
customFieldId (required) string (path) The ID of a Custom Field to delete.

Success Response 204: Custom Field Deleted

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}

3.4 Segmentation

Endpoints for Segmentation Sets and Groups Management.

GET/services/{serviceUuid}/cds/segmentation_sets
Returns a list of Segmentation Sets.Up

Method Overview

Returns a list of Segmentation Sets.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.

Success Response 200: List of Segmentation Sets

{
  "data": [
    {
      "uuid": "string",
      "name": "string",
      "data": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "perPage": 0,
      "currentPage": 0,
      "totalPages": 0,
      "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
      }
    }
  }
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
POST/services/{serviceUuid}/cds/segmentation_sets
Creates a new Segmentation Set.Up

Method Overview

Creates a new Segmentation Set.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
body (required) (body) Segmentation Set data.

Data Parameters

Segmentation Sets data object example

{
  "uuid": "string",
  "name": "string",
  "data": "string"
}

Success Response 201: Created New Segmentation Set

{
  "uuid": "string",
  "name": "string",
  "data": "string"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
GET/services/{serviceUuid}/cds/segmentation_sets/{segmentationSetId}
Returns a Segmentation Set by UUID.Up

Method Overview

Returns a Segmentation Set by UUID.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
segmentationSetId (required) string (path) The ID of a Segmentation Set to get.

Success Response 200: Segmentation Set Data

{
  "uuid": "string",
  "name": "string",
  "data": "string"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
PUT/services/{serviceUuid}/cds/segmentation_sets/{segmentationSetId}
Updates a Segmentation Set.Up

Method Overview

Updates a Segmentation Set.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
segmentationSetId (required) string (path) The ID of a Segmentation Set to update.
body (required) (body) Segmentation Set data.

Data Parameters

Segmentation Set data object example

{
  "uuid": "string",
  "name": "string",
  "data": "string"
}

Success Response 200: Resource updated

Error Response 400: Invalid request

Error Response 404: Resource not found

Error Response 405: Validation exception

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
DELETE/services/{serviceUuid}/cds/segmentation_sets/{segmentationSetId}
Deletes a Segmentation Set.Up

Method Overview

Deletes a Segmentation Set.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
segmentationSetId (required) string (path) The ID of a Segmentation Set to delete.

Success Response 204: Segmentation Set deleted

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
GET/services/{serviceUuid}/cds/segmentation_groups
Returns a list of Segmentation Groups.Up

Method Overview

Returns a list of Segmentation Groups.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.

Success Response 200: List of Segmentation Groups

{
  "data": [
    {
      "uuid": "string",
      "name": "string",
      "data": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "perPage": 0,
      "currentPage": 0,
      "totalPages": 0,
      "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
      }
    }
  }
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
POST/services/{serviceUuid}/cds/segmentation_groups
Creates a Segmentation Group.Up

Method Overview

Creates a Segmentation Group.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
body (required) (body) Segmentation Group data.

Data Parameters

Segmentation Group body object example

{
  "uuid": "string",
  "name": "string",
  "data": "string"
}

Success Response 201: New Segmentation Group Created

{
  "uuid": "string",
  "name": "string",
  "data": "string"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
GET/services/{serviceUuid}/cds/segmentation_groups/{segmentationGroupId}
Returns a Segmentation Group by UUID.Up

Method Overview

Returns a Segmentation Group by UUID.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
segmentationGroupId (required) string (path) The ID of a Segmentation Group to get.

Success Response 200: Segmentation Group data

{
  "uuid": "string",
  "name": "string",
  "data": "string"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
PUT/services/{serviceUuid}/cds/segmentation_groups/{segmentationGroupId}
Updates a Segmentation Group.Up

Method Overview

Updates a Segmentation Group.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
segmentationGroupId (required) string (path) The ID of a Segmentation Group to update.
body (required) (body) Segmentation Group data.

Data Parameters

Segmentation Group object example

{
  "uuid": "string",
  "name": "string",
  "data": "string"
}

Success Response 200: Resource updated

Error Response 400: Invalid request

Error Response 404: Resource not found

Error Response 405: Validation exception

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
DELETE/services/{serviceUuid}/cds/segmentation_groups/{segmentationGroupId}
Deletes a Segmentation Group Set.Up

Method Overview

Deletes a Segmentation Group Set.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
segmentationGroupID (required) string (path) The ID of a Segmentation Group to delete.

Success Response 204: Segmentation Group deleted

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}

3.5 Subscription

Endpoints for Subscriptions and Options Management.

GET/services/{serviceUuid}/cds/subscriptions
Returns a list of Subscriptions.Up

Method Overview

Returns a list of Subscriptions.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
fields array[string] (query) Optional fields (show_deleted).

Success Response 200: List of Subscriptions

{
  "data": [
    {
      "uuid": "string",
      "name": "string",
      "description": "string",
      "created_dt": "string",
      "updated_dt": "string",
      "status": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "perPage": 0,
      "currentPage": 0,
      "totalPages": 0,
      "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
      }
    }
  }
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
POST/services/{serviceUuid}/cds/subscriptions
Creates a new Subscription.Up

Method Overview

Creates a new Subscription.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
body (required) (body) Subscription data.

Data Parameters

Subscription body object example

{
  "uuid": "string",
  "name": "string",
  "description": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "status": "string"
}

Success Response 201: New Subscription Created

{
  "uuid": "string",
  "name": "string",
  "description": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "status": "string"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
GET/services/{serviceUuid}/cds/subscriptions/{subscriptionId}
Returns a Subscription by UUID.Up

Method Overview

Returns a Subscription by UUID.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
subscriptionId (required) string (path) The ID of a Subscription to get.

Success Response 200: Subscription Data Received

{
  "uuid": "string",
  "name": "string",
  "description": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "status": "string"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
PUT/services/{serviceUuid}/cds/subscriptions/{subscriptionId}
Updates a Subscription.Up

Method Overview

Updates a Subscription.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
subscriptionId (required) string (path) The ID of a Subscription to update.
body (required) (body) Subscription Option data.

Data Parameters

Subscription option data object example

{
  "uuid": "string",
  "name": "string",
  "description": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "status": "string"
}

Success Response 200: Resource updated

Error Response 400: Invalid request

Error Response 404: Resource not found

Error Response 405: Validation exception

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
DELETE/services/{serviceUuid}/cds/subscriptions/{subscriptionId}
Deletes a Subscription.Up

Method Overview

Deletes a Subscription.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
subscriptionId (required) string (path) The ID of a Subscription to delete.

Success Response 204: Subscription Option deleted

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
GET/services/{serviceUuid}/cds/subscriptions/options
Returns a list of Subscription Options.Up

Method Overview

Returns a list of Subscription Options.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
subscription_uuid string (path) The ID of a Subscription Option to get.
fields array[string] (query) Optional fields (totals, status, show_deleted)

Data Parameters

List of Subscription Option example

{
  "data": [
    {
      "uuid": "string",
      "name": "string",
      "subscription_uuid": "string",
      "order_num": "string",
      "description": "string",
      "created_dt": "string",
      "updated_dt": "string",
      "status": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "perPage": 0,
      "currentPage": 0,
      "totalPages": 0,
      "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
      }
    }
  }
}

Success Response 200: List of Subscription Option

{
  "data": [
    {
      "uuid": "string",
      "name": "string",
      "subscription_uuid": "string",
      "order_num": "string",
      "description": "string",
      "created_dt": "string",
      "updated_dt": "string",
      "status": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "perPage": 0,
      "currentPage": 0,
      "totalPages": 0,
      "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
      }
    }
  }
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
POST/services/{serviceUuid}/cds/subscriptions/options
Creates a Subscription Options.Up

Method Overview

Creates a Subscription Options.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
body (body) A Subscription Option data.

Data Parameters

Subscription Option data example

{
  "uuid": "string",
  "name": "string",
  "subscription_uuid": "string",
  "order_num": "string",
  "description": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "status": "string"
}

Success Response 201: New Subscription Option response

{
  "uuid": "string",
  "name": "string",
  "subscription_uuid": "string",
  "order_num": "string",
  "description": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "status": "string"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
GET/services/{serviceUuid}/cds/subscriptions/options/{optionId}
Returns a Subscription Option by UUID.Up

Method Overview

Returns a Subscription Option by UUID.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
optionID (required) string (path) The ID of a Subscriptions Option to get.

Success Response 200: List Data

{
  "uuid": "string",
  "name": "string",
  "subscription_uuid": "string",
  "order_num": "string",
  "description": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "status": "string"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
PUT/services/{serviceUuid}/cds/subscriptions/options/{optionId}
Updates a Subscription Option.Up

Method Overview

Updates a Subscription Option.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
optionId (required) string (path) The ID of a Subscriptions Option to update.
body (required) (body) Subscription Option data.

Data Parameters

Subscription Option data example

{
  "uuid": "string",
  "name": "string",
  "subscription_uuid": "string",
  "order_num": "string",
  "description": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "status": "string"
}

Success Response 200: Resource updated

Error Response 400: Invalid request

Error Response 404: Resource not found

Error Response 405: Validation exception

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
DELETE/services/{serviceUuid}/cds/subscriptions/options/{optionId}
Deletes a Subscription Option.Up

Method Overview

Deletes a Subscription Option.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
optionId (required) string (path) The ID of a Subscription Option to delete.

Success Response 204: Subscription Option deleted

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
GET/services/{serviceUuid}/cds/subscriptions/members
Returns a list of a Subscription Option Members.Up

Method Overview

Returns a list of a Subscription Option Members.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
contact_uuid string (query) Filters memberships by UUID of a contact.
option_uuid string (query) Filters memberships by UUID of a subscription option.

Success Response 200: List of Subscription Members

{
  "data": [
    {
      "uuid": "string",
      "option_uuid": "string",
      "contact_uuid": "string",
      "status": "string",
      "joined_dt": "string",
      "updated_dt": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "perPage": 0,
      "currentPage": 0,
      "totalPages": 0,
      "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
      }
    }
  }
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
POST/services/{serviceUuid}/cds/subscriptions/members
Creates or Updates a Subscription Member.Up

Method Overview

Creates or Updates a Subscription Member.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
body (required) (body) Subscription Member data.

Data Parameters

Subscription body object example

{
  "option_uuid": "string",
  "contact_uuid": "string",
  "status": "subscribed"
}

Success Response 201: New Subscription Member Added or Updated

{
  "uuid": "string",
  "option_uuid": "string",
  "contact_uuid": "string",
  "status": "string",
  "joined_dt": "string",
  "updated_dt": "string"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}

3.6 Group

Endpoints for Groups Management.

GET/services/{serviceUuid}/cds/groups
Returns a list of Groups.Up

Method Overview

Returns a list of Groups.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
fields array[string] (query) Optional fields (total, status, show_deleted).

Success Response 200: List of Groups

{
  "data": [
    {
      "uuid": "string",
      "name": "string",
      "group_status": "string",
      "type": "string",
      "match_type": "string",
      "list_uuids": "string",
      "segmentation_uuids": "string",
      "created_dt": "string",
      "updated_dt": "string",
      "description": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "perPage": 0,
      "currentPage": 0,
      "totalPages": 0,
      "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
      }
    }
  }
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
POST/services/{serviceUuid}/cds/groups
Creates a new Group.Up

Method Overview

Creates a new Group.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
body (required) (body) Group data to add.

Data Parameters

Group body object example

{
  "uuid": "string",
  "name": "string",
  "group_status": "string",
  "type": "string",
  "match_type": "string",
  "list_uuids": "string",
  "segmentation_uuids": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "description": "string"
}

Success Response 201: New Group Created

{
  "uuid": "string",
  "name": "string",
  "group_status": "string",
  "type": "string",
  "match_type": "string",
  "list_uuids": "string",
  "segmentation_uuids": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "description": "string"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
GET/services/{serviceUuid}/cds/groups/{groupId}
Returns a Group by UUID.Up

Method Overview

Returns a Group by UUID.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
groupId (required) string (path) The ID of a Group to get.

Success Response 200: Group Data Received

{
  "uuid": "string",
  "name": "string",
  "group_status": "string",
  "type": "string",
  "match_type": "string",
  "list_uuids": "string",
  "segmentation_uuids": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "description": "string"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
PUT/services/{serviceUuid}/cds/groups/{groupId}
Updates a Group.Up

Method Overview

Updates a Group.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
groupId (required) string (path) The ID of a Group to update.
body (required) (body) Group data.

Data Parameters

Group body object example

{
  "uuid": "string",
  "name": "string",
  "group_status": "string",
  "type": "string",
  "match_type": "string",
  "list_uuids": "string",
  "segmentation_uuids": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "description": "string"
}

Success Response 200: Resource updated

Error Response 400: Invalid request

Error Response 404: Resource not found

Error Response 405: Validation exception

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
DELETE/services/{serviceUuid}/cds/groups/{groupId}
Deletes a Group.Up

Method Overview

Deletes a Group.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
groupId (required) string (path) The ID of a Group to delete.

Success Response 204: Group deleted

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
GET/services/{serviceUuid}/cds/group_lists
Returns a list of Group Lists.Up

Method Overview

Returns a list of Group Lists.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
list_uuid string (query) The ID of a List to get.
group_uuid string (query) The ID of a Group List to get.

Success Response 200: List of Group Lists

{
  "data": [
    {
      "group_uuid": "string",
      "list_uuid": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "perPage": 0,
      "currentPage": 0,
      "totalPages": 0,
      "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
      }
    }
  }
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
POST/services/{serviceUuid}/cds/group_lists
Creates a Group List.Up

Method Overview

Creates a Group List.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
body (required) (body) A Group List data to add.

Data Parameters

Group List body object example

{
  "group_uuid": "string",
  "list_uuid": "string"
}

Success Response 201: New Group List response

{
  "group_uuid": "string",
  "list_uuid": "string"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
GET/services/{serviceUuid}/cds/group_lists/{groupListId}
Returns a Group List by UUID.Up

Method Overview

Returns a Group List by UUID.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
groupListId (required) string (path) The ID of a Group List to get.

Success Response 200: Group List data

{
  "group_uuid": "string",
  "list_uuid": "string"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
PUT/services/{serviceUuid}/cds/group_lists/{groupListId}
Updates a Group List.Up

Method Overview

Updates a Group List.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
groupListId (required) string (path) The ID of a Group List to update.
body (required) (body) A Group List data.

Data Parameters

Group List body object example

{
  "group_uuid": "string",
  "list_uuid": "string"
}

Success Response 200: Resource updated

Error Response 400: Invalid request

Error Response 404: Resource not found

Error Response 405: Validation exception

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
GET/services/{serviceUuid}/cds/group_segmentation
Returns a list of Group Segmentations.Up

Method Overview

Returns a list of Group Segmentations.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
segmentation_uuid string (query) The ID of a Segmentation to get.
group_uuid string (query) The ID of a Group to get.

Success Response 200: List of Group Segmentation

{
  "data": [
    {
      "group_uuid": "string",
      "segmentation_uuid": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "perPage": 0,
      "currentPage": 0,
      "totalPages": 0,
      "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
      }
    }
  }
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
POST/services/{serviceUuid}/cds/group_segmentation
Creates a new Group Segmentation.Up

Method Overview

Creates a new Group Segmentation.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
body (required) (body) A Group Segmentation data to add.

Data Parameters

Group Segmentation body object example

{
  "group_uuid": "string",
  "segmentation_uuid": "string"
}

Success Response 201: New Group Segmentation response

{
  "group_uuid": "string",
  "segmentation_uuid": "string"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
GET/services/{serviceUuid}/cds/group_segmentation/{groupSegmentationId}
Gets a Group Segmentation by UUID.Up

Method Overview

Gets a Group Segmentation by UUID.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
groupSegmentationId (required) string (path) The ID of a Group Segmentation to get.

Success Response 200: Group Segmentation data

{
  "group_uuid": "string",
  "segmentation_uuid": "string"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
PUT/services/{serviceUuid}/cds/group_segmentation/{groupSegmentationId}
Updates a Group Segmentation.Up

Method Overview

Updates a Group Segmentation.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
groupSegmentationId (required) string (path) The ID of a Group Segmentation to update.
body (required) (body) Group Segmentation data.

Data Parameters

Group Segmentation body object example

{
  "group_uuid": "string",
  "segmentation_uuid": "string"
}

Success Response 200: Resource updated

Error Response 400: Invalid request

Error Response 404: Resource not found

Error Response 405: Validation exception

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}

3.7 Touchpoint

Endpoints for Touchpoints Management.

GET/services/{serviceUuid}/cds/touchpoints
Returns a list of Touchpoints.Up

Method Overview

Returns a list of Touchpoints.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
contact_uuid string (path) The ID of a Contact to get.
fields array[string] (query) Optional fields (show_deleted).

Success Response 200: List of Touchpoints

{
  "data": [
    {
      "uuid": "string",
      "name": "string",
      "status": "string",
      "type": "string",
      "default_date": "string",
      "created_dt": "string",
      "updated_dt": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "perPage": 0,
      "currentPage": 0,
      "totalPages": 0,
      "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
      }
    }
  }
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
POST/services/{serviceUuid}/cds/touchpoints
Creates a new Touchpoint.Up

Method Overview

Creates a new Touchpoint.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
body (required) (body) A Touchpoint data to add.

Data Parameters

Touchpoint data object example

{
  "uuid": "string",
  "name": "string",
  "status": "string",
  "type": "string",
  "default_date": "string",
  "created_dt": "string",
  "updated_dt": "string"
}

Success Response 201: Created New Touchpoint

{
  "uuid": "string",
  "name": "string",
  "status": "string",
  "type": "string",
  "default_date": "string",
  "created_dt": "string",
  "updated_dt": "string"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
GET/services/{serviceUuid}/cds/touchpoints/{touchpointId}
Gets a Touchpoint by UUID.Up

Method Overview

Gets a Touchpoint by UUID.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
touchpointId (required) string (path) The ID of a Touchpoint to get.

Success Response 200: Touchpoint Data

{
  "uuid": "string",
  "name": "string",
  "status": "string",
  "type": "string",
  "default_date": "string",
  "created_dt": "string",
  "updated_dt": "string"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
PUT/services/{serviceUuid}/cds/touchpoints/{touchpointId}
Updates a Touchpoint.Up

Method Overview

Updates a Touchpoint.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
touchpointId (required) string (path) The ID of a Touchpoint to get.
body (required) (body) A Touchpoint data.

Data Parameters

Touchpoint data object example

{
  "uuid": "string",
  "name": "string",
  "status": "string",
  "type": "string",
  "default_date": "string",
  "created_dt": "string",
  "updated_dt": "string"
}

Success Response 200: Resource updated

Error Response 400: Invalid request

Error Response 404: Resource not found

Error Response 405: Validation exception

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
DELETE/services/{serviceUuid}/cds/touchpoints/{touchpointId}
Deletes a Touchpoint.Up

Method Overview

Deletes a Touchpoint.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
touchpointId (required) string (path) The ID of a Touchpoint to delete.

Success Response 204: Touchpoint deleted

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
GET/services/{serviceUuid}/cds/touchpoints/members
Returns a list of Touchpoint Members.Up

Method Overview

Returns a list of Touchpoint Members.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
contact_uuid string (query) Filters memberships by UUID of a Contact.
touchpoint_uuid string (query) Filters memberships by UUID of a Touchpoint.

Success Response 200: List of Touchpoint Members

{
  "data": [
    {
      "uuid": "string",
      "status": "string",
      "touchpoint_uuid": "string",
      "contact_uuid": "string",
      "joined_dt": "string",
      "updated_dt": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "perPage": 0,
      "currentPage": 0,
      "totalPages": 0,
      "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
      }
    }
  }
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
POST/services/{serviceUuid}/cds/touchpoints/members
Creates or Updates a Touchpoint Membership.Up

Method Overview

Creates or Updates a Touchpoint Membership.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
body (required) (body) A Touchpoint Member data to add.

Data Parameters

Touchpoint Member object example

{
  "status": "subscribed",
  "touchpoint_uuid": "string",
  "contact_uuid": "string"
}

Success Response 201: New Touchpoint Member Response

{
  "uuid": "string",
  "status": "string",
  "touchpoint_uuid": "string",
  "contact_uuid": "string",
  "joined_dt": "string",
  "updated_dt": "string"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}

3.8 Interest

Endpoints for Interests Management.

GET/services/{serviceUuid}/cds/interests
Returns a list of Interests.Up

Method Overview

Returns a list of Interests.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
fields array[string] (query) Optional fields (status, parent_id, level).
embed array[string] (query) Embeds additional entities.

Success Response 200: List of Interests

{
  "data": [
    {
      "uuid": "string",
      "parent_id": 0,
      "service_id": 0,
      "name": "string",
      "status": "string",
      "created_dt": "string",
      "updated_dt": "string",
      "level": 0,
      "description": "string",
      "order_num": 0
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "perPage": 0,
      "currentPage": 0,
      "totalPages": 0,
      "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
      }
    }
  }
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
POST/services/{serviceUuid}/cds/interests
Creates a new Interest.Up

Method Overview

Creates a new Interest.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
body (required) (body) Interest data.

Data Parameters

Interest data object example

{
  "uuid": "string",
  "parent_id": 0,
  "service_id": 0,
  "name": "string",
  "status": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "level": 0,
  "description": "string",
  "order_num": 0
}

Success Response 201: Created New Interest

{
  "uuid": "string",
  "parent_id": 0,
  "service_id": 0,
  "name": "string",
  "status": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "level": 0,
  "description": "string",
  "order_num": 0
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
GET/services/{serviceUuid}/cds/interests/{interestId}
Gets an Interest by UUID.Up

Method Overview

Gets an Interest by UUID.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
interestId (required) string (path) Interest ID to get.
embed array[string] (query) Embeds additional entities.

Success Response 200: Interest Data

{
  "uuid": "string",
  "parent_id": 0,
  "service_id": 0,
  "name": "string",
  "status": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "level": 0,
  "description": "string",
  "order_num": 0
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
PUT/services/{serviceUuid}/cds/interests/{interestId}
Updates an Interest.Up

Method Overview

Updates an Interest.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
interestId (required) string (path) The ID of an Interest to get.
body (required) (body) Interest data.

Data Parameters

Interest data object example

{
  "uuid": "string",
  "parent_id": 0,
  "service_id": 0,
  "name": "string",
  "status": "string",
  "created_dt": "string",
  "updated_dt": "string",
  "level": 0,
  "description": "string",
  "order_num": 0
}

Success Response 200: Resource updated

Error Response 400: Invalid request

Error Response 404: Resource not found

Error Response 405: Validation exception

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
DELETE/services/{serviceUuid}/cds/interests/{interestId}
Deletes an Interest.Up

Method Overview

Deletes an Interest.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
interestId (required) string (path) The ID of an Interest to delete.

Success Response 204: Interest deleted

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
GET/services/{serviceUuid}/cds/interests/members
Returns a list of Interest Members.Up

Method Overview

Returns a list of Interest Members.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
contact_uuid string (query) Filters memberships by UUID of a Contact.
interest_uuid string (query) Filters memberships by UUID of an Interest.

Success Response 200: List of Interests Members

{
  "data": [
    {
      "uuid": "string",
      "status": "string",
      "interest_uuid": "string",
      "contact_uuid": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "perPage": 0,
      "currentPage": 0,
      "totalPages": 0,
      "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
      }
    }
  }
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}
POST/services/{serviceUuid}/cds/interests/members
Creates or Updates an Interest Member.Up

Method Overview

Creates or Updates an Interest Member.

URL Parameters

Name Type Description
serviceUuid (required) string (path) BM account UUID.
body (required) (body) An Interest Member to create or update.

Success Response 201: New Interest Member response

{
  "uuid": "string",
  "status": "string",
  "interest_uuid": "string",
  "contact_uuid": "string"
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string"
    }
  ]
}