Private Individuals Endpoints

The below endpoints have been implemented to allow data manipulation operations on customer records such as creating or updating legal entity or individual customers, addresses, customer representatives, and groups.

NOTE
For endpoints that are used for legal entity customers, see the Legal Entities Endpoints page.

FTOS_ACC_CB_AddUpdateIndividualCustomer

IMPORTANT!
This endpoint replaces the FTOS_CB_AddUpdateIndividualCustomer endpoint. Please refer to the details below on how to use it and adapt your integrations accordingly.

Adds or updates a record in the Account entity representing an individual customer. The set of parameters sent via the request body determines the operation performed at the database level.

Syntax

Copy

{
    "Request":{
        "ActionName":"FTOS_ACC_CB_AddUpdateIndividualCustomer",
        "Data": "{"CustomerInfo":{"customerInternalId":"<customerInternalId>","firstName":"<firstName>","lastName":"<lastName>","emailAddressType":"<emailAddressType>","phoneNumberType":"<phoneNumberType>","UniqueID":"<UniqueID>", "email":"<email>", "mobilePhone":"<mobilePhone>"}}"
    },
    "ApiInfo":{
        "UserName":"<user_name>",
        "Token":"<access_token>"
    }
}

Below is a list of the available parameters:

Parameter	Description
firstName	Mandatory. The customer's firs name.
lastName	Mandatory. The customer's last name.
UniqueID	Mandatory. The customer's unique ID.
email	Mandatory. The email address of the customer.
mobilePhone	Mandatory. The mobile phone number of the customer.
emailAddressType	Optional. The email address type.
phoneNumberType	Optional. The phone number type.

Response

The response indicates the result of the code execution, specifically the result of creating or updating a record in the Account entity. If the record is created or updated successfully, the customerInternalId is returned.

FTOS_ACC_CB_AddUpdateCustomerAddress

IMPORTANT!
This endpoint replaces the FTOS_CB_AddUpdateCustomerAddress endpoint. Please refer to the details below on how to use it and adapt your integrations accordingly.

Adds or updates a record in the Address entity representing a customer's address. The set of parameters sent via the request body determines the operation performed at the database level.

Syntax

The FTOS_ACC_CB_AddUpdateCustomerAddress endpoint is called from within the callAction endpoint. Visit the callAction page for more details.

Copy

{
    "Request":{
        "ActionName":"FTOS_ACC_CB_AddUpdateCustomerAddress",
        "Data": "{"AddressInfo":{"addressIdentifier":"<addressIdentifier>","customerInternalId":"<customerInternalId>","addressType":"<addressType> ","country":"<country>","district":"<district>","city":"<city>","streetName":"<streetName>","streetNo":"<streetNo>","buildingNo":"<buildingNo>","floorNo":"<floorNo>","apartmentNo":"<apartmentNo>","postalCode":"<postalCode>"}}"
    },
    "ApiInfo":{
        "UserName":"<user_name>",
        "Token":"<access_token>"
    }
}

Below is a list of the available parameters:

Parameter	Description
addressType	Mandatory. The type of the address.
country	Mandatory. The country of the address.
district	Mandatory. The district of the address.
city	Mandatory. The city of the address.
streetName	Mandatory. The street name of the address.
streetNo	Mandatory. The street number of the address.
buildingNo	Optional. The building number of the address.
floorNo	Optional. The floor of the address.
apartmentNo	Optional. The apartment number of the address.
postalCode	Optional. Mandatory. The postal code of the address.

Response

FTOS_ACC_CB_AddUpdateCustomerRepresentative

IMPORTANT!
This endpoint replaces the FTOS_CB_AddUpdateCustomerRepresentative endpoint. Please refer to the details below on how to use it and adapt your integrations accordingly.

Adds or updates a record in the AccountRelContact entity representing a customer's representative. The set of parameters sent via the request body determines the operation performed at the database level.

Syntax

The FTOS_ACC_CB_AddUpdateCustomerRepresentative endpoint is called from within the callAction endpoint. Visit the callAction page for more details.

Copy

{
    "Request":{
        "ActionName":"FTOS_ACC_CB_AddUpdateCustomerRepresentative",
        "Data": "{"CustomerRepresentativeInfo":{"customerInternalId":"<customerInternalId>","customerRepresentativeIdentifier":"<customerRepresentativeIdentifier>","customerRepresentativeNo":"<customerRepresentativeNo>","accountRelationType":"<accountRelationType>"}}"
    },
    "ApiInfo":{
        "UserName":"<user_name>",
        "Token":"<access_token>"
    }
}

Below is a list of the available parameters:

Parameter	Description
customerInternalId	Optional. The customer's internal ID.
customerRepresentativeNo	Mandatory. The id of the customer representative.
accountRelationType	Mandatory. The relation type of the representative. Check theDependenciespage for possible values.
customerRepresentativeIdentifier	Optional. The customer representative identifier.