Customer

All the endpoints that can be called on the Customer controller.

Endpoints that require the CUSTOMER_READ permission:

• GET index

• GET item

• POST searchByPrimaryExternalId

• GET timelineByCustomerExternalID

Endpoints that require the CUSTOMER_CUD permission:

• POST index

• PUT index

• PUT item

• DELETE item

• POST addChannelOnly

• PUT updateCustomer

• DELETE itemChannel

• DELETE itemPurgeData

• POST externalEvent

• POST syncWithCRM

• POST createCustomerCRUD

index

get

Returns all the customers.

Authorizations

apikeyAuth

HTTPRequired

Responses

200

OK

application/json

Responseobject

get

/api/v2/customer

HTTPcURLJavaScriptPython

GET /api/v2/customer HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "type": "itemList",
  "itemStart": 0,
  "itemTotal": 8,
  "itemLimit": 15,
  "items": [
    {
      "id": 3,
      "external_primary_id": "marco.test",
      "brand_name": "Mars",
      "firstname": "Marco",
      "lastname": "Test",
      "channels": []
    },
    {
      "id": 4,
      "external_primary_id": "karen.mcfarlane",
      "brand_name": "Mercury",
      "firstname": "Karen",
      "lastname": "McFarlane",
      "channels": [
        {
          "channel_id": 1,
          "channel": "[email protected]"
        }
      ]
    },
    {
      "id": 5,
      "external_primary_id": "jane.doe",
      "brand_name": "Mercury",
      "firstname": "Jane",
      "lastname": "Doe",
      "channels": [
        {
          "channel_id": 1,
          "channel": "[email protected]"
        }
      ]
    },
    {
      "id": 6,
      "external_primary_id": "thomas.testa",
      "brand_name": "Mercury",
      "firstname": "Thomas",
      "lastname": "testa",
      "channels": [
        {
          "channel_id": 1,
          "channel": "[email protected]"
        }
      ]
    },
    {
      "id": 8,
      "external_primary_id": "john.smith",
      "brand_name": "Mercury",
      "firstname": "John",
      "lastname": "Smith",
      "channels": [
        {
          "channel_id": 1,
          "channel": "[email protected]"
        }
      ]
    },
    {
      "id": 9,
      "external_primary_id": "william.branson",
      "brand_name": "Mercury",
      "firstname": "William",
      "lastname": "Branson",
      "channels": [
        {
          "channel_id": 1,
          "channel": "[email protected]"
        }
      ]
    },
    {
      "id": 50,
      "external_primary_id": "seppe.v.donk",
      "brand_name": "CareFree",
      "firstname": "Seppe",
      "lastname": "van Donk",
      "channels": [
        {
          "channel_id": 1,
          "channel": "[email protected]"
        },
        {
          "channel_id": 2,
          "channel": "[phone]"
        }
      ]
    },
    {
      "id": 109,
      "external_primary_id": "c9f0f3d5780701217388d70248964a9f",
      "brand_name": "CareFree",
      "firstname": "Mark",
      "lastname": "Filippo",
      "channels": [
        {
          "channel_id": 2,
          "channel": "[phone]"
        },
        {
          "channel_id": 1,
          "channel": "[email protected]"
        }
      ]
    }
  ]
}

index

post

Creates a new customer.

Most parameters are optional but depending on the presence of other parameters.

Authorizations

apikeyAuth

HTTPRequired

Body

multipart/form-data

channel_idstringOptional

type: ^([0-9]+|email|telephone|facebook|twitter)$ = ' ' Name or the ID of the channel e.g. email or telephone. Can only be processed if customer_link_channel is set.

customer_link_channelstringOptional

type: string The name of the address, depending on the channel e.g. a phone number or an email address.

brand_idstringOptional

type: number

primary_idstringOptional

type: string The external primary ID of the customer.

noSyncstringOptional

type: any Does not update the ticket with the new linked channel(s) if sent along with the request.

firstnamestringOptional

type: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿŠš\.\-\' ]+$ = ' '

lastnamestringOptional

type: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿŠš\.\-\' ]+$ = ' '

ticket_idstringOptional

type: number = null

extra_emailstringOptional

type: string = null Has to be a valid email address format.

extra_telephonestringOptional

type: ^\+[0-9]+$ = null

Responses

200

Successful response

application/json

post

/api/v2/customer

HTTPcURLJavaScriptPython

POST /api/v2/customer HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 208

{
  "channel_id": "text",
  "customer_link_channel": "text",
  "brand_id": "text",
  "primary_id": "text",
  "noSync": "text",
  "firstname": "text",
  "lastname": "text",
  "ticket_id": "text",
  "extra_email": "text",
  "extra_telephone": "text"
}

200

Successful response

index

put

Updates this customer's name.

PrimaryID, brandID and customerID are all optional, but dependent on the presence of at least one.

Authorizations

apikeyAuth

HTTPRequired

Body

application/x-www-form-urlencoded

primaryIDstringOptional

The external primary ID of the customer.

brandIDstringOptional

type: number = null

customerIDstringOptional

type: number = null

firstnamestringOptional

type: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿŠš\.\-\' ]+$ = null

lastnamestringOptional

type: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿŠš\.\-\' ]+$ = null

Responses

200

Successful response

application/json

put

/api/v2/customer

HTTPcURLJavaScriptPython

PUT /api/v2/customer HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 94

"primaryID='text'&brandID='text'&customerID='text'&firstname='text'&lastname='text'"

200

Successful response

item

get

Returns all the data of this customer.

Authorizations

apikeyAuth

HTTPRequired

Path parameters

idstringRequired

Responses

200

Successful response

application/json

get

/api/v2/customer/{id}

HTTPcURLJavaScriptPython

GET /api/v2/customer/{id} HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

item

put

Updates any fields existing on this customer, including custom fields.

See the example for how to update custom fields. It should always follow the pattern of "custom_" followed by the name of the custom field.

If you want to update or add multiple customer channels at once, it should be done in 2 parameters:

• customerChannelType_0 (corresponding to the channel type ID)

• customerChannelValue_0 (corresponding to the address of the channel you want to add)

The 0 would be incremental if you choose to do multiple.

Authorizations

apikeyAuth

HTTPRequired

Path parameters

idstringRequired

Body

application/x-www-form-urlencoded

brandIDstringOptional

type: number

firstnamestringOptional

type: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿŠš\.\-\' ]+$ = ' '

lastnamestringOptional

type: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿŠš\.\-\' ]+$ = ' '

Responses

200

OK

application/json

Responseobject

put

/api/v2/customer/{id}

HTTPcURLJavaScriptPython

PUT /api/v2/customer/{id} HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 55

"brandID='text'&firstname='text'&lastname='text'"

200

OK

{
  "type": "result",
  "message": "Customer updated."
}

item

delete

Permanently deletes this customer.

Authorizations

apikeyAuth

HTTPRequired

Path parameters

idstringRequired

Responses

200

Successful response

application/json

delete

/api/v2/customer/{id}

HTTPcURLJavaScriptPython

DELETE /api/v2/customer/{id} HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

searchByPrimaryExternalID

post

Searches for this customer by primary external ID.

Authorizations

apikeyAuth

HTTPRequired

Body

multipart/form-data

primary_idstringOptional

type: string

The external primary ID of the customer.

brand_idstringOptional

type: number

Responses

200

Successful response

application/json

post

/api/v2/customer/SearchByPrimaryExternalID

HTTPcURLJavaScriptPython

POST /api/v2/customer/SearchByPrimaryExternalID HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 39

{
  "primary_id": "text",
  "brand_id": "text"
}

200

Successful response

searchByCustomerChannelValue

post

Searches for this customer by channel value.

Authorizations

apikeyAuth

HTTPRequired

Body

multipart/form-data

customerChannelValuestringOptional

type: string

The channel value of the customer.

brand_idstringOptional

type: number

Responses

200

Successful response

application/json

post

/api/v2/customer/SearchByCustomerChannelValue

HTTPcURLJavaScriptPython

POST /api/v2/customer/SearchByCustomerChannelValue HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 49

{
  "customerChannelValue": "text",
  "brand_id": "text"
}

200

Successful response

addChannelOnly

post

Adds a channel to a customer.

Authorizations

apikeyAuth

HTTPRequired

Body

multipart/form-data

customer_idstringOptional

type: number = null

primary_idstringOptional

type: string = null

The external primary ID of the customer.

brand_idstringOptional

type: number

extra_emailstringOptional

type: string = null

Should be in a valid email address format.

extra_telephonestringOptional

type: ^\+[0-9]+$ = null

extra_twitterstringOptional

type: ^[a-zA-Z0-9_ ]+$ = null

extra_facebookstringOptional

type: number = null

Responses

200

Successful response

application/json

post

/api/v2/customer/addChannelOnly

HTTPcURLJavaScriptPython

POST /api/v2/customer/addChannelOnly HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 153

{
  "customer_id": "text",
  "primary_id": "text",
  "brand_id": "text",
  "extra_email": "text",
  "extra_telephone": "text",
  "extra_twitter": "text",
  "extra_facebook": "text"
}

200

Successful response

updateCustomer

put

Updates the fields of this customer.

Similar to how PUT item works.

If you want to update custom fields, just put the name of the field you want to update as the key and the value of the field you want to update as the value.

Authorizations

apikeyAuth

HTTPRequired

Body

application/x-www-form-urlencoded

externalPrimaryIDstringOptional

type: string

brandIDstringOptional

type: number

firstnamestringOptional

type: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿŠš\.\-\' ]+$

lastnamestringOptional

type: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿŠš\.\-\' ]+$

Responses

200

Successful response

application/json

put

/api/v2/customer/updateCustomer

HTTPcURLJavaScriptPython

PUT /api/v2/customer/updateCustomer HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 82

"externalPrimaryID='text'&brandID='text'&firstname='text'&lastname='text'"

200

Successful response

itemChannel

delete

Permanently deletes a channel endpoint of this customer.

Authorizations

apikeyAuth

HTTPRequired

Path parameters

idstringRequired

Responses

200

Successful response

application/json

delete

/api/v2/customer/channel/{id}

HTTPcURLJavaScriptPython

DELETE /api/v2/customer/channel/{id} HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

timelineByCustomerExternalID

get

Returns the timeline from this customer by external primary ID.

Authorizations

apikeyAuth

HTTPRequired

Query parameters

brand_idstringOptional

external_idstringOptional

External primary ID of the customer.

Responses

200

Successful response

application/json

get

/api/v2/customer/timelineByCustomerExternalID

HTTPcURLJavaScriptPython

GET /api/v2/customer/timelineByCustomerExternalID HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

itemPurgeData

delete

Permanently deletes customer data and related items/tickets.

Authorizations

apikeyAuth

HTTPRequired

Path parameters

idstringRequired

Responses

200

Successful response

application/json

delete

/api/v2/customer/purgeData/{id}

HTTPcURLJavaScriptPython

DELETE /api/v2/customer/purgeData/{id} HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

externalEvent

post

Creates a new customer event e.g. an order or marketing mail to the customer timeline.

Authorizations

apikeyAuth

HTTPRequired

Body

multipart/form-data

customer_idstringOptional

type: number = null

external_idstringOptional

type: string = null

The external primary ID of the customer.

brand_idstringOptional

type: number

initiated_bystringOptional

type: string

messagestringOptional

type: string

source_urlstringOptional

type: string

Responses

200

Successful response

application/json

post

/api/v2/customer/externalEvent

HTTPcURLJavaScriptPython

POST /api/v2/customer/externalEvent HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 120

{
  "customer_id": "text",
  "external_id": "text",
  "brand_id": "text",
  "initiated_by": "text",
  "message": "text",
  "source_url": "text"
}

200

Successful response

syncWithCRM

post

Synchronizes customer data for this customer with the CRM if a CRM lookup URL is configured for the brand.

Authorizations

apikeyAuth

HTTPRequired

Body

multipart/form-data

brandIDstringOptional

type: number

channelstringOptional

type: string

The name of the channel e.g. telephone or email

addressstringOptional

type: string = null

Responses

200

Successful response

application/json

post

/api/v2/customer/syncWithCRM

HTTPcURLJavaScriptPython

POST /api/v2/customer/syncWithCRM HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 52

{
  "brandID": "text",
  "channel": "text",
  "address": "text"
}

200

Successful response

createCustomerCRUD

post

Creates a customer using the CRUD.

Authorizations

apikeyAuth

HTTPRequired

Body

multipart/form-data

primaryIDstringOptional

type: string

The external primary ID of the customer.

brandIDstringOptional

type: number

firstnamestringOptional

type: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿŠš\.\-\' ]+$

lastnamestringOptional

type: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿŠš\.\-\' ]+$

Responses

200

Successful response

application/json

post

/api/v2/customer/createCustomerCRUD

HTTPcURLJavaScriptPython

POST /api/v2/customer/createCustomerCRUD HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 74

{
  "primaryID": "text",
  "brandID": "text",
  "firstname": "text",
  "lastname": "text"
}

200

Successful response