API - Customer
These customer methods makes it possible to get, create, update or delete a customer data within Deployteq.
POSTCreate Customer
https://deployteq.net/app/api/rest/public/v2/customer?token={{token}}
Create a new customer in Deployteq
[POST] https://deployteq.net/app/api/rest/public/v2/customer?token={{token}}
HEADERS
Content-Type
application/json
PARAMS
token
{{token}}
API token
Bodyraw (json)
json
{
"address": "Amersfoortseweg",
"address2": "",
"address3": "",
"addressnumber": "",
"addressnumbersuffix": "",
"alt_address": "",
"alt_address2": "",
"alt_address3": "",
"alt_addressnumber": "",
"alt_addressnumbersuffix": "",
"alt_city": "",
"alt_country": "",
"alt_emailaddress": "",
"alt_state": "",
"alt_zipcode": "",
"birthday": null,
"birthplace": "",
"city": "Huis ter Heide",
"companyname": "Deployteq",
"contactman": "",
"country": "",
"department": "",
"emailaddress": "tpm@deployteq.com",
"externalid": "123455432",
"faxnumber": "",
"firstname": "Angelo",
"gender": "MAN",
"homephone": "+31306988080",
"imageurl": "",
"initials": "",
"jobtitle": "",
"lastname": "Kleij",
"maritalstatus": "UNKNOWN",
"middlename": "",
"mobilephone": "",
"optin": "Y",
"password": "",
"pobox": "0",
"prefix": "",
"smsoptin": "Y",
"state": "",
"status": "PROSPECT",
"suffix": "",
"title": "Ing.",
"username": "a.vanderkleij",
"website": "",
"workextension": "",
"workmobile": "",
"workphone": "",
"zipcode": "3712BC"
}Example Request
Create Customer
curl
curl --location -g 'https://{{portal}}.myclang.com/app/api/rest/public/v2/customer?token={{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"address": "Amersfoortseweg",
"address2": "",
"address3": "",
"addressnumber": "",
"addressnumbersuffix": "",
"alt_address": "",
"alt_address2": "",
"alt_address3": "",
"alt_addressnumber": "",
"alt_addressnumbersuffix": "",
"alt_city": "",
"alt_country": "",
"alt_emailaddress": "",
"alt_state": "",
"alt_zipcode": "",
"birthday": null,
"birthplace": "",
"city": "Zeist",
"companyname": "e-Village",
"contactman": "",
"country": "",
"department": "",
"emailaddress": "angelo@e-village.nl",
"externalid": "123455432",
"faxnumber": "",
"firstname": "Angelo",
"gender": "MAN",
"homephone": "+31306988080",
"imageurl": "",
"initials": "",
"jobtitle": "",
"lastname": "Kleij",
"maritalstatus": "UNKNOWN",
"middlename": "",
"mobilephone": "",
"optin": "Y",
"password": "",
"pobox": "0",
"prefix": "",
"smsoptin": "Y",
"state": "",
"status": "PROSPECT",
"suffix": "",
"title": "Ing.",
"username": "a.vanderkleij",
"website": "",
"workextension": "",
"workmobile": "",
"workphone": "",
"zipcode": "3705GJ"
}'Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers
GETGet Customer(s) by customer field
https://deployteq.net/app/api/rest/public/v2/customer?filter[emailaddress]={{emailaddress}}&token={{token}}
Search a customer based on predefined customer fields, which can be added as a filter in the endpoint:
https://deployteq.net/app/api/rest/public/v2/customer?filter[{{customer_fieldname}}]={{email}}&token={{token}}
See the possible customer fields which can be used as a filter:
- lastname
- firstname
- prefix
- initials
- gender
- addressnumber
- zipcode
- companyname
- mobilephone
- emailaddress
- optin
- externalid
- username
All possible conditions which can be included within the endpoint:
- ?limit={{amount}
- ?page={{number}}
- ?filter[{{customer_fieldname}}]={{value}}
- ?sort=[{"property":"{{COLUMN}}","direction":"{{direction:DESC/ASC}}"}]
PARAMS
filter[emailaddress]
{{emailaddress}}
Find a customer based on the field email address
token
{{token}}
API token
Example Request
Get Customer(s) by email
curl
curl --location -g 'https://mokup.myclang.com/app/api/rest/public/v2/customer?filter[emailaddress]=Ethelyn.Murphy45%40gmail.com&token={{token}}'200 OK
Example Response
json
[
{
"address": "Amersfoortseweg",
"address2": "",
"address3": "",
"addressnumber": "",
"addressnumbersuffix": "",
"alt_address": "",
"alt_address2": "",
"alt_address3": "",
"alt_addressnumber": "",
"alt_addressnumbersuffix": "",
"alt_city": "",
"alt_country": "",
"alt_emailaddress": "",
"alt_state": "",
"alt_zipcode": "",
"birthday": null,
"birthplace": "",
"bouncecount_hard": "0",
"bouncecount_soft": "0",
"city": "Zeist",
"companyname": "e-Village",
"complaintcount": "0",
"contactman": "",
"country": "",
"createdat": "2018-02-06 11:52:06",
"createdby": "Angelo van der Kleij",
"department": "",
"emailaddress": "angelo@e-village.nl",
"emailtype": "MULTIPART",
"externalid": "123455432",
"faxnumber": "",
"firstname": "Angelo van der Kleij",
"gender": "MAN",
"homephone": "+31306988080",
"id": "91",
"imageurl": "",
"initials": "",
"jobtitle": "",
"lastname": "Kleij",
"mailstatus": "ACTIVE",
"maritalstatus": "UNKNOWN",
"middlename": "",
"mobilephone": "",
"modifiedat": "2020-05-29 09:14:27",
"modifiedby": "Import #15 repeat 1006",
"optin": "Y",
"password": "testen",
"pobox": "0",
"prefix": "",
"smsoptin": "Y",
"state": "",
"status": "PROSPECT",
"suffix": "",
"title": "Ing.",
"username": "a.vanderkleij",
"website": "",
"workextension": "",
"workmobile": "",
"workphone": "",
"zipcode": "3705GJ",
"mailable": "1",
"options": [
{
"identifier": "E1",
"type": "string",
"value": "000000001",
"fieldname": "sf_autoincrement"
},
{
"identifier": "E11",
"type": "select",
"value": null,
"fieldname": "language"
},
{
"identifier": "E12",
"type": "date",
"value": "",
"fieldname": "demo"
},
{
"identifier": "E13",
"type": "string",
"value": "",
"fieldname": "Customer - Language"
},
{
"identifier": "E14",
"type": "float",
"value": "222000.00",
"fieldname": "sf_ AnnualRevenue"
},
{
"identifier": "E15",
"type": "int",
"value": "22",
"fieldname": "sf_ NumberOfEmployees"
},
{
"identifier": "E16",
"type": "date",
"value": null,
"fieldname": "sf_ ConvertedDate"
},
{
"identifier": "E17",
"type": "string",
"value": "",
"fieldname": "json"
},
{
"identifier": "E18",
"type": "string",
"value": "",
"fieldname": "TEST"
},
{
"identifier": "E19",
"type": "string",
"value": "",
"fieldname": "restock"
},
{
"identifier": "E2",
"type": "string",
"value": "",
"fieldname": "sf_optin"
},
{
"identifier": "E20",
"type": "string",
"value": "",
"fieldname": "flag"
},
{
"identifier": "E21",
"type": "string",
"value": null,
"fieldname": "Verzendvoorwaarden"
},
{
"identifier": "E22",
"type": "date",
"value": "",
"fieldname": "optinDate"
},
{
"identifier": "E3",
"type": "string",
"value": "",
"fieldname": "SHA256 Relay42"
}
]
},
{
"address": "",
"address2": "",
"address3": "",
"addressnumber": "",
"addressnumbersuffix": "",
"alt_address": "",
"alt_address2": "",
"alt_address3": "",
"alt_addressnumber": "",
"alt_addressnumbersuffix": "",
"alt_city": "",
"alt_country": "",
"alt_emailaddress": "",
"alt_state": "",
"alt_zipcode": "",
"birthday": null,
"birthplace": "",
"bouncecount_hard": "0",
"bouncecount_soft": "0",
"city": "",
"companyname": "",
"complaintcount": "0",
"contactman": "",
"country": "",
"createdat": "2019-02-01 14:16:37",
"createdby": "Angelo van der Kleij",
"department": "",
"emailaddress": "angelo@e-village.nl",
"emailtype": "MULTIPART",
"externalid": "",
"faxnumber": "",
"firstname": "Angelo van der Kleij",
"gender": "UNKNOWN",
"homephone": "",
"id": "348",
"imageurl": "",
"initials": "",
"jobtitle": "",
"lastname": "",
"mailstatus": "ACTIVE",
"maritalstatus": "UNKNOWN",
"middlename": "",
"mobilephone": "",
"modifiedat": "2020-05-29 09:14:27",
"modifiedby": "Import #15 repeat 1006",
"optin": "Y",
"password": "",
"pobox": "0",
"prefix": "",
"smsoptin": "Y",
"state": "",
"status": "SUSPECT",
"suffix": "",
"title": "",
"username": "",
"website": "",
"workextension": "",
"workmobile": "",
"workphone": "",
"zipcode": "",
"mailable": "1",
"options": [
{
"identifier": "E1",
"type": "string",
"value": null,
"fieldname": "sf_autoincrement"
},
{
"identifier": "E11",
"type": "select",
"value": null,
"fieldname": "language"
},
{
"identifier": "E12",
"type": "date",
"value": "",
"fieldname": "demo"
},
{
"identifier": "E13",
"type": "string",
"value": null,
"fieldname": "Customer - Language"
},
{
"identifier": "E14",
"type": "float",
"value": null,
"fieldname": "sf_ AnnualRevenue"
},
{
"identifier": "E15",
"type": "int",
"value": null,
"fieldname": "sf_ NumberOfEmployees"
},
{
"identifier": "E16",
"type": "date",
"value": null,
"fieldname": "sf_ ConvertedDate"
},
{
"identifier": "E17",
"type": "string",
"value": null,
"fieldname": "json"
},
{
"identifier": "E18",
"type": "string",
"value": null,
"fieldname": "TEST"
},
{
"identifier": "E19",
"type": "string",
"value": null,
"fieldname": "restock"
},
{
"identifier": "E2",
"type": "string",
"value": null,
"fieldname": "sf_optin"
},
{
"identifier": "E20",
"type": "string",
"value": null,
"fieldname": "flag"
},
{
"identifier": "E21",
"type": "string",
"value": null,
"fieldname": "Verzendvoorwaarden"
},
{
"identifier": "E22",
"type": "date",
"value": "",
"fieldname": "optinDate"
},
{
"identifier": "E3",
"type": "string",
"value": null,
"fieldname": "SHA256 Relay42"
}
]
}
]Server
nginx
Date
Fri, 29 May 2020 07:26:52 GMT
Content-Type
application/json
Transfer-Encoding
chunked
Connection
keep-alive
Vary
Accept-Encoding
Content-Security-Policy
frame-ancestors 'self'
X-Frame-Options
SAMEORIGIN
X-XSS-Protection
1; mode=block
X-Content-Type-Options
nosniff
Strict-Transport-Security
max-age=31536000; includeSubDomains
Access-Control-Allow-Origin
*
Content-Encoding
gzip
GETGet Customer by Id
https://deployteq.net/app/api/rest/public/v2/customer/:customerid?token={{token}}
Get a customer based on the Deployteq customerid
HEADERS
Content-Type
application/json
PARAMS
token
{{token}}
PATH VARIABLES
customerid
Example Request
Get Customer by Id
curl
curl --location -g --request GET 'https://mokup.myclang.com/app/api/rest/public/v2/customer/91?token={{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"address": "Amersfoortseweg",
"address2": "",
"address3": "",
"addressnumber": "",
"addressnumbersuffix": "",
"alt_address": "",
"alt_address2": "",
"alt_address3": "",
"alt_addressnumber": "",
"alt_addressnumbersuffix": "",
"alt_city": "",
"alt_country": "",
"alt_emailaddress": "",
"alt_state": "",
"alt_zipcode": "",
"birthday": null,
"birthplace": "",
"bouncecount_hard": "0",
"bouncecount_soft": "0",
"city": "Zeist",
"companyname": "e-Village",
"complaintcount": "0",
"contactman": "",
"country": "",
"createdat": "2018-02-06 11:52:06",
"createdby": "Angelo van der Kleij",
"department": "",
"emailaddress": "angelo@e-village.nl",
"emailtype": "MULTIPART",
"externalid": "123455432",
"faxnumber": "",
"firstname": "Miranda",
"gender": "WOMAN",
"homephone": "+31306988080",
"id": "91",
"imageurl": "",
"initials": "",
"jobtitle": "",
"lastname": "Blom",
"mailstatus": "ACTIVE",
"maritalstatus": "UNKNOWN",
"middlename": "",
"mobilephone": "",
"modifiedat": "2019-12-03 11:11:16",
"modifiedby": "DATAHOOK; Webhook-abc",
"optin": "Y",
"password": "wazzup12",
"pobox": "0",
"prefix": "",
"smsoptin": "Y",
"state": "",
"status": "PROSPECT",
"suffix": "",
"title": "Ing.",
"username": "a.vanderkleij",
"website": "",
"workextension": "",
"workmobile": "",
"workphone": "",
"zipcode": "3705GJ",
"E1": "000000001",
"E11": null,
"E12": null,
"E13": "",
"E14": "222000.00",
"E15": "22",
"E16": null,
"E17": "",
"E18": null,
"E19": null,
"E2": "",
"E20": null,
"E3": "",
"mailable": "1"
}'200 OK
Example Response
json
{
"address": "Amersfoortseweg",
"address2": "",
"address3": "",
"addressnumber": "",
"addressnumbersuffix": "",
"alt_address": "",
"alt_address2": "",
"alt_address3": "",
"alt_addressnumber": "",
"alt_addressnumbersuffix": "",
"alt_city": "",
"alt_country": "",
"alt_emailaddress": "",
"alt_state": "",
"alt_zipcode": "",
"birthday": null,
"birthplace": "",
"bouncecount_hard": "0",
"bouncecount_soft": "0",
"city": "Zeist",
"companyname": "e-Village",
"complaintcount": "0",
"contactman": "",
"country": "",
"createdat": "2018-02-06 11:52:06",
"createdby": "Angelo van der Kleij",
"department": "",
"emailaddress": "angelo@e-village.nl",
"emailtype": "MULTIPART",
"externalid": "123455432",
"faxnumber": "",
"firstname": "Angelo van der Kleij",
"gender": "WOMAN",
"homephone": "+31306988080",
"id": "91",
"imageurl": "",
"initials": "",
"jobtitle": "",
"lastname": "Blom",
"mailstatus": "ACTIVE",
"maritalstatus": "UNKNOWN",
"middlename": "",
"mobilephone": "",
"modifiedat": "2020-05-29 09:14:27",
"modifiedby": "Import #15 repeat 1006",
"optin": "Y",
"password": "testen",
"pobox": "0",
"prefix": "",
"smsoptin": "Y",
"state": "",
"status": "PROSPECT",
"suffix": "",
"title": "Ing.",
"username": "a.vanderkleij",
"website": "",
"workextension": "",
"workmobile": "",
"workphone": "",
"zipcode": "3705GJ",
"mailable": "1",
"options": [
{
"identifier": "E1",
"type": "string",
"value": "000000001",
"fieldname": "sf_autoincrement"
},
{
"identifier": "E11",
"type": "select",
"value": null,
"fieldname": "language"
},
{
"identifier": "E12",
"type": "date",
"value": "",
"fieldname": "demo"
},
{
"identifier": "E13",
"type": "string",
"value": "",
"fieldname": "Customer - Language"
},
{
"identifier": "E14",
"type": "float",
"value": "222000.00",
"fieldname": "sf_ AnnualRevenue"
},
{
"identifier": "E15",
"type": "int",
"value": "22",
"fieldname": "sf_ NumberOfEmployees"
},
{
"identifier": "E16",
"type": "date",
"value": null,
"fieldname": "sf_ ConvertedDate"
},
{
"identifier": "E17",
"type": "string",
"value": "",
"fieldname": "json"
},
{
"identifier": "E18",
"type": "string",
"value": "",
"fieldname": "TEST"
},
{
"identifier": "E19",
"type": "string",
"value": "",
"fieldname": "restock"
},
{
"identifier": "E2",
"type": "string",
"value": "",
"fieldname": "sf_optin"
},
{
"identifier": "E20",
"type": "string",
"value": "",
"fieldname": "flag"
},
{
"identifier": "E21",
"type": "string",
"value": null,
"fieldname": "Verzendvoorwaarden"
},
{
"identifier": "E22",
"type": "date",
"value": "",
"fieldname": "optinDate"
},
{
"identifier": "E3",
"type": "string",
"value": "",
"fieldname": "SHA256 Relay42"
}
]
}Server
nginx
Date
Fri, 29 May 2020 07:27:39 GMT
Content-Type
application/json
Transfer-Encoding
chunked
Connection
keep-alive
Vary
Accept-Encoding
Content-Security-Policy
frame-ancestors 'self'
X-Frame-Options
SAMEORIGIN
X-XSS-Protection
1; mode=block
X-Content-Type-Options
nosniff
Strict-Transport-Security
max-age=31536000; includeSubDomains
Access-Control-Allow-Origin
*
Content-Encoding
gzip
PUTUpdate Customer by Id
https://deployteq.net/app/api/rest/public/v2/customer/:customerid?token={{token}}
The Deployteq customer id is used in the endpoint to determine which customer needs to be updated;
[PUT] https://deployteq.net/app/api/rest/public/v2/customer/{{customerid}}?token={{token}}
HEADERS
Content-Type
application/json
PARAMS
token
{{token}}
PATH VARIABLES
customerid
Deployteq customer id
Bodyraw (json)
json
{
"address": "Amersfoortseweg",
"address2": "",
"address3": "",
"addressnumber": "",
"addressnumbersuffix": "",
"alt_address": "",
"alt_address2": "",
"alt_address3": "",
"alt_addressnumber": "",
"alt_addressnumbersuffix": "",
"alt_city": "",
"alt_country": "",
"alt_emailaddress": "",
"alt_state": "",
"alt_zipcode": "",
"birthday": null,
"birthplace": "",
"city": "Huis ter Heide",
"companyname": "Deployteq",
"contactman": "",
"country": "",
"department": "",
"emailaddress": "tpm@deployteq.com",
"externalid": "123455432",
"faxnumber": "",
"firstname": "Angelo",
"gender": "MAN",
"homephone": "+31306988080",
"imageurl": "",
"initials": "A",
"jobtitle": "",
"lastname": "Kleij",
"maritalstatus": "UNKNOWN",
"middlename": "",
"mobilephone": "",
"optin": "Y",
"password": "",
"pobox": "0",
"prefix": "",
"smsoptin": "Y",
"state": "",
"status": "CUSTOMER",
"suffix": "",
"title": "Ing.",
"username": "a.vanderkleij",
"website": "https://deployteq.com",
"workextension": "",
"workmobile": "",
"workphone": "",
"zipcode": "3712BC"
}Example Request
Update Customer by Id
curl
curl --location -g --request PUT 'https://mokup.myclang.com/app/api/rest/public/v2/customer/:customerid?token={{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"address": "Amersfoortseweg",
"address2": "",
"address3": "",
"addressnumber": "",
"addressnumbersuffix": "",
"alt_address": "",
"alt_address2": "",
"alt_address3": "",
"alt_addressnumber": "",
"alt_addressnumbersuffix": "",
"alt_city": "",
"alt_country": "",
"alt_emailaddress": "",
"alt_state": "",
"alt_zipcode": "",
"birthday": null,
"birthplace": "",
"city": "Zeist",
"companyname": "e-Village",
"contactman": "",
"country": "",
"department": "",
"emailaddress": "angelo@e-village.nl",
"emailtype": "MULTIPART",
"externalid": "123455432",
"faxnumber": "",
"firstname": "Miranda",
"gender": "WOMAN",
"homephone": "+31306988080",
"imageurl": "",
"initials": "",
"jobtitle": "",
"lastname": "Blom",
"maritalstatus": "UNKNOWN",
"middlename": "",
"mobilephone": "",
"optin": "Y",
"password": "Testen",
"pobox": "0",
"prefix": "",
"smsoptin": "Y",
"state": "",
"status": "PROSPECT",
"suffix": "",
"title": "Ing.",
"username": "a.vanderkleij",
"website": "",
"workextension": "",
"workmobile": "",
"workphone": "",
"zipcode": "3705GJ"
}'200 OK
Example Response
json
{
"address": "Amersfoortseweg",
"address2": "",
"address3": "",
"addressnumber": "",
"addressnumbersuffix": "",
"alt_address": "",
"alt_address2": "",
"alt_address3": "",
"alt_addressnumber": "",
"alt_addressnumbersuffix": "",
"alt_city": "",
"alt_country": "",
"alt_emailaddress": "",
"alt_state": "",
"alt_zipcode": "",
"birthday": null,
"birthplace": "",
"bouncecount_hard": "0",
"bouncecount_soft": "0",
"city": "Zeist",
"companyname": "e-Village",
"complaintcount": "0",
"contactman": "",
"country": "",
"createdat": "2018-02-06 11:52:06",
"createdby": "Angelo van der Kleij",
"department": "",
"emailaddress": "angelo@e-village.nl",
"emailtype": "MULTIPART",
"externalid": "123455432",
"faxnumber": "",
"firstname": "Miranda",
"gender": "WOMAN",
"homephone": "+31306988080",
"id": "91",
"imageurl": "",
"initials": "",
"jobtitle": "",
"lastname": "Blom",
"mailstatus": "ACTIVE",
"maritalstatus": "UNKNOWN",
"middlename": "",
"mobilephone": "",
"modifiedat": "2020-05-29 13:58:59",
"modifiedby": "Angelo van der Kleij",
"optin": "Y",
"password": "Testen",
"pobox": "0",
"prefix": "",
"smsoptin": "Y",
"state": "",
"status": "PROSPECT",
"suffix": "",
"title": "Ing.",
"username": "a.vanderkleij",
"website": "",
"workextension": "",
"workmobile": "",
"workphone": "",
"zipcode": "3705GJ",
"mailable": "1",
"options": [
{
"identifier": "E1",
"type": "string",
"value": "000000001",
"fieldname": "sf_autoincrement"
},
{
"identifier": "E11",
"type": "select",
"value": null,
"fieldname": "language"
},
{
"identifier": "E12",
"type": "date",
"value": "",
"fieldname": "demo"
},
{
"identifier": "E13",
"type": "string",
"value": "",
"fieldname": "Customer - Language"
},
{
"identifier": "E14",
"type": "float",
"value": "222000.00",
"fieldname": "sf_ AnnualRevenue"
},
{
"identifier": "E15",
"type": "int",
"value": "22",
"fieldname": "sf_ NumberOfEmployees"
},
{
"identifier": "E16",
"type": "date",
"value": null,
"fieldname": "sf_ ConvertedDate"
},
{
"identifier": "E17",
"type": "string",
"value": "",
"fieldname": "json"
},
{
"identifier": "E18",
"type": "string",
"value": "",
"fieldname": "TEST"
},
{
"identifier": "E19",
"type": "string",
"value": "",
"fieldname": "restock"
},
{
"identifier": "E2",
"type": "string",
"value": "",
"fieldname": "sf_optin"
},
{
"identifier": "E20",
"type": "string",
"value": "",
"fieldname": "flag"
},
{
"identifier": "E21",
"type": "string",
"value": null,
"fieldname": "Verzendvoorwaarden"
},
{
"identifier": "E22",
"type": "date",
"value": "",
"fieldname": "optinDate"
},
{
"identifier": "E3",
"type": "string",
"value": "",
"fieldname": "SHA256 Relay42"
}
]
}Server
nginx
Date
Fri, 29 May 2020 11:58:59 GMT
Content-Type
application/json
Transfer-Encoding
chunked
Connection
keep-alive
Vary
Accept-Encoding
Content-Security-Policy
frame-ancestors 'self'
X-Frame-Options
SAMEORIGIN
X-XSS-Protection
1; mode=block
X-Content-Type-Options
nosniff
Strict-Transport-Security
max-age=31536000; includeSubDomains
Access-Control-Allow-Origin
*
Content-Encoding
gzip