createCustomerAutomatic
Create a Customer AND a Feedback / Review Request Sequence with Automatic Scheduling (No delay before sending the First Feedback / Review Request)
This API call creates a Customer in Reputation Builder, AND schedules an Automatic Email AND / OR SMS Feedback / Review Request Sequence, WITH NO DELAY BEFORE SENDING THE FIRST FEEDBACK / REVIEW REQUEST, based on settings of the Company / Location -> Notifications -> Email AND SMS Tabs
/createCustomerAutomatic
Usage and SDK Samples
curl -X POST -H "key: [[apiKey]]" "https://reputationcrm.com/v2/createCustomerAutomatic"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerApi;
import java.io.File;
import java.util.*;
public class CustomerApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
CustomerApi apiInstance = new CustomerApi();
String companyid = companyid_example; // String | Company ID
String firstname = firstname_example; // String | Customer First Name
String lastname = lastname_example; // String | Customer Last Name
String sendtype = sendtype_example; // String | Feedback / Review Requests Sending Method (1 = Send via Email, 2 = Send via SMS, 1,2 = Send via Email AND SMS) Allowed values: "1", "2", "1,2"
String email = email_example; // String | Customer Email
String mobile = mobile_example; // String | Customer Mobile Phone #: The Mobile Phone # must be formatted in its international version. Eg: +33647523335 (+33 = Country Code for France). No leading Zero on Mobile Phone # usually (NOTE: some countries might a leading zero). Here is an excellent script for mobile number formatting: https://github.com/jackocnr/intl-tel-input
String address = address_example; // String | Customer Postal Address
String zipcode = zipcode_example; // String | Customer Zipcode
String city = city_example; // String | Customer City
String state = state_example; // String | Customer State / Province / Region
String country = country_example; // String | Customer Country: has to be set to the name of the Country in its original language. Eg: Spain = España. Download the sql file of all countries: https://reputationcrm.com/api/repcrm-api-docs/countries.txt
String language = language_example; // String | Customer Language (Language 2 letter ISO code: en, fr, es, it...). For a complete list of supported languages, please check: https://reputationaegis.com/en/features/supported-languages
String notes = notes_example; // String | Additional Customer Notes
try {
'String' result = apiInstance.createCustomerAutomatic(companyid, firstname, lastname, sendtype, email, mobile, address, zipcode, city, state, country, language, notes);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CustomerApi#createCustomerAutomatic");
e.printStackTrace();
}
}
}
import io.swagger.client.api.CustomerApi;
public class CustomerApiExample {
public static void main(String[] args) {
CustomerApi apiInstance = new CustomerApi();
String companyid = companyid_example; // String | Company ID
String firstname = firstname_example; // String | Customer First Name
String lastname = lastname_example; // String | Customer Last Name
String sendtype = sendtype_example; // String | Feedback / Review Requests Sending Method (1 = Send via Email, 2 = Send via SMS, 1,2 = Send via Email AND SMS) Allowed values: "1", "2", "1,2"
String email = email_example; // String | Customer Email
String mobile = mobile_example; // String | Customer Mobile Phone #: The Mobile Phone # must be formatted in its international version. Eg: +33647523335 (+33 = Country Code for France). No leading Zero on Mobile Phone # usually (NOTE: some countries might a leading zero). Here is an excellent script for mobile number formatting: https://github.com/jackocnr/intl-tel-input
String address = address_example; // String | Customer Postal Address
String zipcode = zipcode_example; // String | Customer Zipcode
String city = city_example; // String | Customer City
String state = state_example; // String | Customer State / Province / Region
String country = country_example; // String | Customer Country: has to be set to the name of the Country in its original language. Eg: Spain = España. Download the sql file of all countries: https://reputationcrm.com/api/repcrm-api-docs/countries.txt
String language = language_example; // String | Customer Language (Language 2 letter ISO code: en, fr, es, it...). For a complete list of supported languages, please check: https://reputationaegis.com/en/features/supported-languages
String notes = notes_example; // String | Additional Customer Notes
try {
'String' result = apiInstance.createCustomerAutomatic(companyid, firstname, lastname, sendtype, email, mobile, address, zipcode, city, state, country, language, notes);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CustomerApi#createCustomerAutomatic");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"key"];
String *companyid = companyid_example; // Company ID
String *firstname = firstname_example; // Customer First Name
String *lastname = lastname_example; // Customer Last Name
String *sendtype = sendtype_example; // Feedback / Review Requests Sending Method (1 = Send via Email, 2 = Send via SMS, 1,2 = Send via Email AND SMS) Allowed values: "1", "2", "1,2"
(default to 1)
String *email = email_example; // Customer Email (optional)
String *mobile = mobile_example; // Customer Mobile Phone #: The Mobile Phone # must be formatted in its international version. Eg: +33647523335 (+33 = Country Code for France). No leading Zero on Mobile Phone # usually (NOTE: some countries might a leading zero). Here is an excellent script for mobile number formatting: https://github.com/jackocnr/intl-tel-input
(optional)
String *address = address_example; // Customer Postal Address (optional)
String *zipcode = zipcode_example; // Customer Zipcode (optional)
String *city = city_example; // Customer City (optional)
String *state = state_example; // Customer State / Province / Region (optional)
String *country = country_example; // Customer Country: has to be set to the name of the Country in its original language. Eg: Spain = España. Download the sql file of all countries: https://reputationcrm.com/api/repcrm-api-docs/countries.txt
(optional)
String *language = language_example; // Customer Language (Language 2 letter ISO code: en, fr, es, it...). For a complete list of supported languages, please check: https://reputationaegis.com/en/features/supported-languages
(optional)
String *notes = notes_example; // Additional Customer Notes (optional)
CustomerApi *apiInstance = [[CustomerApi alloc] init];
// Create a Customer AND a Feedback / Review Request Sequence with Automatic Scheduling (No delay before sending the First Feedback / Review Request)
[apiInstance createCustomerAutomaticWith:companyid
firstname:firstname
lastname:lastname
sendtype:sendtype
email:email
mobile:mobile
address:address
zipcode:zipcode
city:city
state:state
country:country
language:language
notes:notes
completionHandler: ^('String' output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var ReputationCrmApi = require('reputation_crm_api');
var defaultClient = ReputationCrmApi.ApiClient.instance;
// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['key'] = "Token"
var api = new ReputationCrmApi.CustomerApi()
var companyid = companyid_example; // {String} Company ID
var firstname = firstname_example; // {String} Customer First Name
var lastname = lastname_example; // {String} Customer Last Name
var sendtype = sendtype_example; // {String} Feedback / Review Requests Sending Method (1 = Send via Email, 2 = Send via SMS, 1,2 = Send via Email AND SMS) Allowed values: "1", "2", "1,2"
var opts = {
'email': email_example, // {String} Customer Email
'mobile': mobile_example, // {String} Customer Mobile Phone #: The Mobile Phone # must be formatted in its international version. Eg: +33647523335 (+33 = Country Code for France). No leading Zero on Mobile Phone # usually (NOTE: some countries might a leading zero). Here is an excellent script for mobile number formatting: https://github.com/jackocnr/intl-tel-input
'address': address_example, // {String} Customer Postal Address
'zipcode': zipcode_example, // {String} Customer Zipcode
'city': city_example, // {String} Customer City
'state': state_example, // {String} Customer State / Province / Region
'country': country_example, // {String} Customer Country: has to be set to the name of the Country in its original language. Eg: Spain = España. Download the sql file of all countries: https://reputationcrm.com/api/repcrm-api-docs/countries.txt
'language': language_example, // {String} Customer Language (Language 2 letter ISO code: en, fr, es, it...). For a complete list of supported languages, please check: https://reputationaegis.com/en/features/supported-languages
'notes': notes_example // {String} Additional Customer Notes
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.createCustomerAutomatic(companyid, firstname, lastname, sendtype, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class createCustomerAutomaticExample
{
public void main()
{
// Configure API key authorization: api_key
Configuration.Default.ApiKey.Add("key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.ApiKeyPrefix.Add("key", "Bearer");
var apiInstance = new CustomerApi();
var companyid = companyid_example; // String | Company ID
var firstname = firstname_example; // String | Customer First Name
var lastname = lastname_example; // String | Customer Last Name
var sendtype = sendtype_example; // String | Feedback / Review Requests Sending Method (1 = Send via Email, 2 = Send via SMS, 1,2 = Send via Email AND SMS) Allowed values: "1", "2", "1,2"
(default to 1)
var email = email_example; // String | Customer Email (optional)
var mobile = mobile_example; // String | Customer Mobile Phone #: The Mobile Phone # must be formatted in its international version. Eg: +33647523335 (+33 = Country Code for France). No leading Zero on Mobile Phone # usually (NOTE: some countries might a leading zero). Here is an excellent script for mobile number formatting: https://github.com/jackocnr/intl-tel-input
(optional)
var address = address_example; // String | Customer Postal Address (optional)
var zipcode = zipcode_example; // String | Customer Zipcode (optional)
var city = city_example; // String | Customer City (optional)
var state = state_example; // String | Customer State / Province / Region (optional)
var country = country_example; // String | Customer Country: has to be set to the name of the Country in its original language. Eg: Spain = España. Download the sql file of all countries: https://reputationcrm.com/api/repcrm-api-docs/countries.txt
(optional)
var language = language_example; // String | Customer Language (Language 2 letter ISO code: en, fr, es, it...). For a complete list of supported languages, please check: https://reputationaegis.com/en/features/supported-languages
(optional)
var notes = notes_example; // String | Additional Customer Notes (optional)
try
{
// Create a Customer AND a Feedback / Review Request Sequence with Automatic Scheduling (No delay before sending the First Feedback / Review Request)
'String' result = apiInstance.createCustomerAutomatic(companyid, firstname, lastname, sendtype, email, mobile, address, zipcode, city, state, country, language, notes);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling CustomerApi.createCustomerAutomatic: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('key', 'Bearer');
$api_instance = new Swagger\Client\Api\CustomerApi();
$companyid = companyid_example; // String | Company ID
$firstname = firstname_example; // String | Customer First Name
$lastname = lastname_example; // String | Customer Last Name
$sendtype = sendtype_example; // String | Feedback / Review Requests Sending Method (1 = Send via Email, 2 = Send via SMS, 1,2 = Send via Email AND SMS) Allowed values: "1", "2", "1,2"
$email = email_example; // String | Customer Email
$mobile = mobile_example; // String | Customer Mobile Phone #: The Mobile Phone # must be formatted in its international version. Eg: +33647523335 (+33 = Country Code for France). No leading Zero on Mobile Phone # usually (NOTE: some countries might a leading zero). Here is an excellent script for mobile number formatting: https://github.com/jackocnr/intl-tel-input
$address = address_example; // String | Customer Postal Address
$zipcode = zipcode_example; // String | Customer Zipcode
$city = city_example; // String | Customer City
$state = state_example; // String | Customer State / Province / Region
$country = country_example; // String | Customer Country: has to be set to the name of the Country in its original language. Eg: Spain = España. Download the sql file of all countries: https://reputationcrm.com/api/repcrm-api-docs/countries.txt
$language = language_example; // String | Customer Language (Language 2 letter ISO code: en, fr, es, it...). For a complete list of supported languages, please check: https://reputationaegis.com/en/features/supported-languages
$notes = notes_example; // String | Additional Customer Notes
try {
$result = $api_instance->createCustomerAutomatic($companyid, $firstname, $lastname, $sendtype, $email, $mobile, $address, $zipcode, $city, $state, $country, $language, $notes);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CustomerApi->createCustomerAutomatic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerApi;
# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'key'} = "Bearer";
my $api_instance = WWW::SwaggerClient::CustomerApi->new();
my $companyid = companyid_example; # String | Company ID
my $firstname = firstname_example; # String | Customer First Name
my $lastname = lastname_example; # String | Customer Last Name
my $sendtype = sendtype_example; # String | Feedback / Review Requests Sending Method (1 = Send via Email, 2 = Send via SMS, 1,2 = Send via Email AND SMS) Allowed values: "1", "2", "1,2"
my $email = email_example; # String | Customer Email
my $mobile = mobile_example; # String | Customer Mobile Phone #: The Mobile Phone # must be formatted in its international version. Eg: +33647523335 (+33 = Country Code for France). No leading Zero on Mobile Phone # usually (NOTE: some countries might a leading zero). Here is an excellent script for mobile number formatting: https://github.com/jackocnr/intl-tel-input
my $address = address_example; # String | Customer Postal Address
my $zipcode = zipcode_example; # String | Customer Zipcode
my $city = city_example; # String | Customer City
my $state = state_example; # String | Customer State / Province / Region
my $country = country_example; # String | Customer Country: has to be set to the name of the Country in its original language. Eg: Spain = España. Download the sql file of all countries: https://reputationcrm.com/api/repcrm-api-docs/countries.txt
my $language = language_example; # String | Customer Language (Language 2 letter ISO code: en, fr, es, it...). For a complete list of supported languages, please check: https://reputationaegis.com/en/features/supported-languages
my $notes = notes_example; # String | Additional Customer Notes
eval {
my $result = $api_instance->createCustomerAutomatic(companyid => $companyid, firstname => $firstname, lastname => $lastname, sendtype => $sendtype, email => $email, mobile => $mobile, address => $address, zipcode => $zipcode, city => $city, state => $state, country => $country, language => $language, notes => $notes);
print Dumper($result);
};
if ($@) {
warn "Exception when calling CustomerApi->createCustomerAutomatic: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: api_key
swagger_client.configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['key'] = 'Bearer'
# create an instance of the API class
api_instance = swagger_client.CustomerApi()
companyid = companyid_example # String | Company ID
firstname = firstname_example # String | Customer First Name
lastname = lastname_example # String | Customer Last Name
sendtype = sendtype_example # String | Feedback / Review Requests Sending Method (1 = Send via Email, 2 = Send via SMS, 1,2 = Send via Email AND SMS) Allowed values: "1", "2", "1,2"
(default to 1)
email = email_example # String | Customer Email (optional)
mobile = mobile_example # String | Customer Mobile Phone #: The Mobile Phone # must be formatted in its international version. Eg: +33647523335 (+33 = Country Code for France). No leading Zero on Mobile Phone # usually (NOTE: some countries might a leading zero). Here is an excellent script for mobile number formatting: https://github.com/jackocnr/intl-tel-input
(optional)
address = address_example # String | Customer Postal Address (optional)
zipcode = zipcode_example # String | Customer Zipcode (optional)
city = city_example # String | Customer City (optional)
state = state_example # String | Customer State / Province / Region (optional)
country = country_example # String | Customer Country: has to be set to the name of the Country in its original language. Eg: Spain = España. Download the sql file of all countries: https://reputationcrm.com/api/repcrm-api-docs/countries.txt
(optional)
language = language_example # String | Customer Language (Language 2 letter ISO code: en, fr, es, it...). For a complete list of supported languages, please check: https://reputationaegis.com/en/features/supported-languages
(optional)
notes = notes_example # String | Additional Customer Notes (optional)
try:
# Create a Customer AND a Feedback / Review Request Sequence with Automatic Scheduling (No delay before sending the First Feedback / Review Request)
api_response = api_instance.create_customer_automatic(companyid, firstname, lastname, sendtype, email=email, mobile=mobile, address=address, zipcode=zipcode, city=city, state=state, country=country, language=language, notes=notes)
pprint(api_response)
except ApiException as e:
print("Exception when calling CustomerApi->createCustomerAutomatic: %s\n" % e)
Parameters
Name | Description |
---|---|
companyid* |
String
Company ID
Required
|
firstname* |
String
Customer First Name
Required
|
lastname* |
String
Customer Last Name
Required
|
String
Customer Email
|
|
mobile |
String
Customer Mobile Phone #: The Mobile Phone # must be formatted in its international version. Eg: +33647523335 (+33 = Country Code for France). No leading Zero on Mobile Phone # usually (NOTE: some countries might a leading zero). Here is an excellent script for mobile number formatting: https://github.com/jackocnr/intl-tel-input
|
address |
String
Customer Postal Address
|
zipcode |
String
Customer Zipcode
|
city |
String
Customer City
|
state |
String
Customer State / Province / Region
|
country |
String
Customer Country: has to be set to the name of the Country in its original language. Eg: Spain = España. Download the sql file of all countries: https://reputationcrm.com/api/repcrm-api-docs/countries.txt
|
language |
String
Customer Language (Language 2 letter ISO code: en, fr, es, it...). For a complete list of supported languages, please check: https://reputationaegis.com/en/features/supported-languages
|
sendtype* |
String
Feedback / Review Requests Sending Method (1 = Send via Email, 2 = Send via SMS, 1,2 = Send via Email AND SMS) Allowed values: "1", "2", "1,2"
Enum:
1 , 2 , 1,2
Required
|
notes |
String
Additional Customer Notes
|