Upsert Customer

PUT

/v1/customers/source/{source}/externalId/{externalId}

Update or Insert Customer by External ID and source

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Example

{
    "externalId": "{{customerExternalId}}",
    "source": "{{source}}",
    "name": "Complyt",
    "address": {
        "city": "Sacramento",
        "country": "US",
        "state": "CA",
        "street": "944 W. Wintergreen St.",
        "zip": "95823"
    },
    "customerType": "RETAIL",
    "externalTimestamps": {
        "createdDate": "2022-10-19T07:00:00.000Z",
        "updatedDate": "2022-10-19T09:07:54.585Z"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request PUT 'https://sandbox.complyt.io/v1/customers/source//externalId/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "externalId": "",
    "source": "",
    "name": "Complyt",
    "address": {
        "city": "Sacramento",
        "country": "US",
        "state": "CA",
        "street": "944 W. Wintergreen St.",
        "zip": "95823"
    },
    "customerType": "RETAIL",
    "externalTimestamps": {
        "createdDate": "2022-10-19T07:00:00.000Z",
        "updatedDate": "2022-10-19T09:07:54.585Z"
    }
}'

Responses

🟢200Successful operation

application/json

Body

Example

{
    "complytId": "9f8ee193-1a71-42b4-801d-ee1d8a161fbe",
    "externalId": "externalIdExample",
    "source": "1",
    "name": "Complyt",
    "address": {
        "city": "Sacramento",
        "country": "US",
        "county": null,
        "state": "CA",
        "street": "944 W. Wintergreen St.",
        "zip": "95823",
        "isPartial": false
    },
    "email": "example@some.mail.com",
    "customerType": "RETAIL",
    "internalTimestamps": {
        "createdDate": "2023-01-10T17:40:44.357",
        "updatedDate": "2023-01-11T17:10:21.275"
    },
    "externalTimestamps": {
        "createdDate": "2022-10-19T07:00:00",
        "updatedDate": "2022-10-19T09:07:54.585"
    },
    "comment": "this is a customer"
}

🟢201Successful operation

🟠400Something is wrong with your request

🟠401Unauthorized

🟠403Forbidden

🟠404Customer Not Found

🔴500Internal Error

Modified at 2025-01-01 15:21:30

Get All Customers

Update Customer