Update a customer

POST

{role}

{id}

update

{propertyToUpdate}

Update a customer

curl --request POST \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/customer/v3/{role}/{id}/update/{propertyToUpdate}' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dummy": "<string>"
}
'

import requests

url = "https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/customer/v3/{role}/{id}/update/{propertyToUpdate}"

payload = { "dummy": "<string>" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({dummy: '<string>'})
};

fetch('https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/customer/v3/{role}/{id}/update/{propertyToUpdate}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/customer/v3/{role}/{id}/update/{propertyToUpdate}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'dummy' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/customer/v3/{role}/{id}/update/{propertyToUpdate}"

	payload := strings.NewReader("{\n  \"dummy\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/customer/v3/{role}/{id}/update/{propertyToUpdate}")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dummy\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/customer/v3/{role}/{id}/update/{propertyToUpdate}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dummy\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "description": "061-Usage Limit '24H_RETAIL' Amount Exceeded",
  "id": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

role

enum<string>

required

Which customer role the customer is

Available options:

CORPORATE,

PRIVATE

string

required

The customer id of customer you want to update

propertyToUpdate

enum<string>

required

What property you want to update

Available options:

DELETE_TEMPORARY_ADDRESS

Query Parameters

auditUser

string

required

The audit user to log the request

Body

application/json

The new value of selected property. You should only provide a value for the property you want to update, the other ones should be null

Should set the value of the property you are updating, leave rest empty

dummy

string

Dummy value not used

Response

Successful update of customer

description

string

When a payment is declined, a response description is returned, if available, providing more context on why the transaction failed. This includes a return code and a brief explanation. If multiple issues cause the decline, only one response description is sent; the most recent reason for decline is returned. If the payment is successful, the resourceResponse attribute is returned with null value.

Example:

"061-Usage Limit '24H_RETAIL' Amount Exceeded"

string

Will contain the ID of the resource that has been created or updated

⌘I

Update a customer

curl --request POST \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/customer/v3/{role}/{id}/update/{propertyToUpdate}' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dummy": "<string>"
}
'

import requests

url = "https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/customer/v3/{role}/{id}/update/{propertyToUpdate}"

payload = { "dummy": "<string>" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({dummy: '<string>'})
};

fetch('https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/customer/v3/{role}/{id}/update/{propertyToUpdate}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/customer/v3/{role}/{id}/update/{propertyToUpdate}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'dummy' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/customer/v3/{role}/{id}/update/{propertyToUpdate}"

	payload := strings.NewReader("{\n  \"dummy\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/customer/v3/{role}/{id}/update/{propertyToUpdate}")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dummy\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/customer/v3/{role}/{id}/update/{propertyToUpdate}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dummy\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "description": "061-Usage Limit '24H_RETAIL' Amount Exceeded",
  "id": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}