Customers

Manage your customers, including viewing, updating, creating, and anonymising customer records.

Get Customers

Endpoint

GET https://api.rdentify.com/v1/workspaces/<workspace-id>/customers

Retrieve a list of all customers for a particular workspace.

Optional URL Parameters

  • pageSize: Maximum number of records to return per request (max 50)
  • page: Page number in the paginated results

Request Example

GET https://api.rdentify.com/v1/workspaces/<workspace-id>/customers
Authorization: Basic base64(API_KEY:API_SECRET)

Response Example

{
    "success": true,
    "code": 200,
    "detail": "Request completed successfully",
    "data": [
        {
            "id": "987654321",
            "firstName": "Jane",
            "lastName": "Doe",
            "email": "[email protected]",
            "interactions": []
        },
        {
            "id": "123456789",
            "firstName": "John",
            "lastName": "Doe",
            "email": "[email protected]",
            "interactions": []
        }
    ],
    "meta": {
        "totalResults": 2,
        "totalPages": 1,
        "currentPage": 1,
        "pageSize": 10
    }
}

Get Customer

Endpoint

GET https://api.rdentify.com/v1/workspaces/<workspace-id>/customers/<customer-id>

Retrieve details for a specific customer based on their external ID in your database.

Request Example

GET https://api.rdentify.com/v1/workspaces/<workspace-id>/customers/<customer-id>
Authorization: Basic base64(API_KEY:API_SECRET)

Response Example

{
    "success": true,
    "code": 200,
    "detail": "Request completed successfully",
    "data": {
        "id": "123456789",
        "firstName": "John",
        "lastName": "Doe",
        "email": "[email protected]",
        "interactions": [
            {
                "id": "437a1ee7-b569-ee11-b006-6045bdd13058",
                "status": "Pending",
                "priority": "Low",
                "link": "https://landing.rdentify.com/interactions/NzA3ZmRkMmEtNzMzZi00ZWNjLThlNzctYWVkZDRjZGEwZTVkOjQzN2ExZWU3LWI1NjktZWUxMS1iMDA2LTYwNDViZGQxMzA1OA",
                "expiresAt": null,
                "createdAt": "2023-10-13T10:47:29.2008091",
                "customerId": "123456789",
                "type": "RG Bot",
                "data": null,
                "context": [
                    "property_1",
                    "property_2"
                ]
            }
        ]
    },
    "meta": null
}

Create Customer

Endpoint

POST https://api.rdentify.com/v1/workspaces/<workspace-id>/customers

Create a new customer record within a specific workspace.

Request Body Example

{
    "id": "123456789",
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "[email protected]"
}

Request Example

POST https://api.rdentify.com/v1/workspaces/<workspace-id>/customers
Authorization: Basic base64(API_KEY:API_SECRET)

Response Example

{
    "success": true,
    "code": 200,
    "detail": "Request completed successfully",
    "data": {
        "id": "123456789",
        "firstName": "John",
        "lastName": "Doe",
        "email": "[email protected]",
        "interactions": []
    },
    "meta": null
}

Update Customer

Endpoint

PATCH https://api.rdentify.com/v1/workspaces/<workspace-id>/customers/<customer-id>

Update the details for an existing customer within a specific workspace. Supported properties include firstName, lastName and email. You can send all or some.

Request Body Example

{
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]"
}

Request Example

PATCH https://api.rdentify.com/v1/workspaces/<workspace-id>/customers/<customer-id>
Authorization: Basic base64(API_KEY:API_SECRET)

Response Example

{
    "success": true,
    "code": 200,
    "detail": "Request completed successfully",
    "data": {
        "id": "123456789",
        "firstName": "John",
        "lastName": "Doe",
        "email": "[email protected]",
        "interactions": [
            {
                "id": "437a1ee7-b569-ee11-b006-6045bdd13058",
                "status": "Pending",
                "priority": "Low",
                "link": "https://landing.rdentify.com/interactions/NzA3ZmRkMmEtNzMzZi00ZWNjLThlNzctYWVkZDRjZGEwZTVkOjQzN2ExZWU3LWI1NjktZWUxMS1iMDA2LTYwNDViZGQxMzA1OA",
                "expiresAt": null,
                "createdAt": "2023-10-13T10:47:29.2008091",
                "customerId": "123456789",
                "type": "RG Bot",
                "data": null,
                "context": [
                    "property_1",
                    "property_2"
                ]
            }
        ]
    },
    "meta": null
}

Anonymise Customer

Endpoint

POST https://api.rdentify.com/v1/workspaces/<workspace-id>/customers/<customer-id>/anonymise

Remove personal details for an existing customer within a specific workspace while retaining their history.

Request Example

POST https://api.rdentify.com/v1/workspaces/<workspace-id>/customers/<customer-id/anonymise
Authorization: Basic base64(API_KEY:API_SECRET)

Response Example

{
    "success": true,
    "code": 200,
    "detail": "Request completed successfully",
    "data": null,
    "meta": null
}

Next Steps