POST (create) a batch of customers

POST

/clients/{clientno}/customers/batches

Creates a batch of new customers. If a customer already exists, it will be updated (same as PUT customer(s), see details under PUT (update) one customer).

There are two ways to create new customer(s):

Use POST /clients/{clientno}/customers to create one new customer; input one customer object. The data will be validated and customer created immediately. You will get a response describing the status and result. The new customer is immediately active and ready to be used. Or:

Use POST /clients/{clientno}/customers/batches to create a batch of new customers; input an array of customer objects. The data will be stored, but not processed immediately. The output will present a batchUuid that you must keep track of. Processing is done asynchronously (later) and the bathcUuid can be used to retrieve the batch processing status and result using GET /clients/{clientno}/batches/{batchuuid}

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢202

application/json

Accepted for processing

Body

🟠400BadRequest

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/clients//customers/batches' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "metadata": {
        "userId": "TestUser"
    },
    "customers": [
        {
            "customerNo": "543210",
            "name": "Owe Armstrong",
            "postalAddress": {
                "addressLine1": "C/O ARMchair industries",
                "addressLine2": "707 Arm street",
                "addressLine3": "Appartment 8",
                "postalCode": "1234",
                "cityName": "Oslo",
                "countryText": "Norway"
            },
            "customerCategory": "CONS",
            "emailAddressDocument": [
                "owea@testarmrest.no"
            ],
            "secondaryEmailAddress": [
                "test2.email@testarmrest.no"
            ],
            "phoneNo": "99887766",
            "organizationNo": "984842252",
            "dateOfBirth": "1956-01-12",
            "distribution": {
                "type": "M",
                "einvoiceCode": 0
            },
            "sellerReference": "ARMref",
            "buyerReference": "OA"
        },
        {
            "customerNo": "765432",
            "name": "Bill Lossius",
            "postalAddress": {
                "addressLine1": "Farm alley 9",
                "addressLine2": "Birchwood neighborhood",
                "postalCode": "5432",
                "cityName": "Bergen",
                "countryCode": "NO"
            },
            "customerCategory": "CONS",
            "phoneNo": "98989898",
            "organizationNo": "987654321",
            "distribution": {
                "type": "M"
            },
            "buyerReference": "BL"
        }
    ]
}'

Response Example

202 - Batch accepted for treatment

{
    "status": "NOT-PROCESSED",
    "result": "PENDING",
    "message": "Document batch accepted for processing",
    "batchUuid": "8NlwdOIM1YLVFP9-WOwkYQ",
    "getResult": "https://api.staging.amili.no/arm/v1/clients/2218/batches/8NlwdOIM1YLVFP9-WOwkYQ"
}

Modified at 2026-04-14 09:49:15

DELETE a customer

PUT (update) a batch of customers