API

2 min read

The Eucera API enables the management of user and subscription data, offering endpoints for creating, updating, and deleting records. It supports seamless integration and data operations. 

Delete User API #

Endpoint:
DELETE https://api.eucera.ai/v1/users

Description:
This API allows you to delete a user by providing their unique identifyId.

Request Details: #

  • Method: DELETE

  • Headers:

    • X-EUCERA-API-KEY (required): The API key for authorization.

      • Example: f73vtZ1WSCF5MxYLG1op5_ghDvIrxizNpnUDI5mhDGk

  • Body:
    Content-Type: application/json

     
     
    { "identifyId": "91LXudnMyzIcI6IynKcc9KILRS2" }

    • Fields:

      • identifyId (required): The unique identifier of the user to be logically deleted.

Response: #

  • Success (200):
    The user was successfully marked as deleted.

     
     
    { "message": "User successfully deleted" }

  • Error Responses:

    • 401 Unauthorized:
      Missing or invalid API key.

       
       
      { "error": "Unauthorized" }

    • 404 Not Found:
      User with the provided identifyId does not exist.

       
       
      { "error": "User not found" }

    • 423 Rate Limit Exceeded

    • 500 Internal Server Error:
      An unexpected error occurred.

       
       
      { "error": "Internal server error" }

Example Request (Postman): #

  1. Method: DELETE

  2. URL: https://api.eucera.ai/v1/users

  3. Headers:

    • Key: X-EUCERA-API-KEY

  4. Body:

     
     
    { "identifyId": "91LXudnMyzIcI6IynKcc9KILRS2" }

Get Single User API #

Endpoint:
GET https://api.eucera.ai/v1/users/{identifyId}

Description:
This API retrieves detailed information about a single user using their unique identifyId.

Request Details: #

  • Method: GET

  • Headers:

    • X-EUCERA-API-KEY (required): The API key for authorization.

      • Example: f73vtZ1WSCF5MxYLG1op5_ghDvIrxizNpnUDI5mhDGk

  • Path Parameter:

    • {identifyId} (required): The unique identifier of the user to be retrieved.

Response: #

  • Success (200):
    Returns the user’s details in JSON format.

     
				
					{
"id": "f63d4158-0171-4f0d-bc62-29112c0fc82c",
"userType": "USER",
"identifyId": "bTMwUidOQiZhMazBDWGAAmuRnu9N2",
"email": "alice.johnson@eucera.io",
"name": "Alice Johnson",
"role": null,
"phone": null,
"timezone": null,
"leadDate": null,
"signUpDate": 1734539909141,
"lastModifiedDate": 1731863535216,
"firstVisitDate": 1734539909141,
"lastSeenDate": 1731863535216,
"lastSubscriptionIdentifier": "3a7d6f3b-8f1e-46b5-8731-c3e981e9abf7",
"allSubscriptionIdentifiers": [
"3a7d6f3b-8f1e-46b5-8731-c3e981e9abf7",
"562e6da7-13ad-4c16-adfc-572932ed3749"
],
"location": null,
"customAttributes": {
"key1": "value1",
"key2": 6.0
},
"products": [
{
"product": "X7B69NRTTBM7",
"environment": 1
}
],
"numberOfVisits": 77,
"image": "https://lh3.googleusercontent.com/a/AcBcqILXSthaPBfUYlnMPF9msfBbPUojM0_BYjtq0dG8vJshWF_wg=s96-c",
"pqlScore": null
}

  • Error Responses:

    • 401 Unauthorized:
      Missing or invalid API key.

       
       

      { "error": "Unauthorized" }

    • 404 Not Found:
      User with the provided identifyId does not exist.

       
       

      { "error": "User not found" }

    • 423 Rate Limit Exceeded

    • 500 Internal Server Error:
      An unexpected error occurred.

       
       

      { "error": "Internal server error" }