Customers

List all users.

get

Authorizations

api-key

api-keystringRequired

API Key

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

get

/v1/crm/customers

HTTPcURLJavaScriptPython

GET /v1/crm/customers HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "users": [
      {
        "firstName": "text",
        "lastName": "text",
        "email": "text",
        "phone": "text",
        "phoneCountry": "text",
        "phoneCountryCalling": "text",
        "number": "text",
        "cityId": "text",
        "birthDate": "text",
        "gender": {},
        "unsubscribed": true,
        "internalNote": "text",
        "archivedAt": "text",
        "archivedBy": "text",
        "archivedVia": "text",
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "id": "text"
      }
    ],
    "next": "text",
    "query": {}
  }
}

Creates a new user.

post

Authorizations

api-key

api-keystringRequired

API Key

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

400

Functional Error

application/json

post

/v1/crm/customers

HTTPcURLJavaScriptPython

POST /v1/crm/customers HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 229

{
  "params": {
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "phone": "text",
    "phoneCallingCode": "text",
    "cityId": "text",
    "birthDate": "text",
    "gender": "F",
    "passcode": "text",
    "number": "text",
    "unsubscribed": true,
    "internalNote": "text"
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true,
    "id": "text"
  }
}

Returns a specific user.

get

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

400

Functional Error

application/json

get

/v1/crm/customers/{uid}

HTTPcURLJavaScriptPython

GET /v1/crm/customers/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "user": {
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "phone": "text",
      "phoneCountry": "text",
      "phoneCountryCalling": "text",
      "number": "text",
      "cityId": "text",
      "birthDate": "text",
      "gender": {},
      "unsubscribed": true,
      "internalNote": "text",
      "archivedAt": "text",
      "archivedBy": "text",
      "archivedVia": "text",
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "id": "text"
    }
  }
}

Deletes a new user.

delete

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

delete

/v1/crm/customers/{uid}

HTTPcURLJavaScriptPython

DELETE /v1/crm/customers/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Updates a specific user.

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

400

Functional Error

application/json

patch

/v1/crm/customers/{uid}

HTTPcURLJavaScriptPython

PATCH /v1/crm/customers/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 215

{
  "params": {
    "id": "text",
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "phone": "text",
    "cityId": "text",
    "birthDate": "text",
    "gender": "F",
    "passcode": "text",
    "number": "text",
    "unsubscribed": true,
    "internalNote": "text"
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Exports all users with support for incremental fetching.

get

Authorizations

api-key

api-keystringRequired

API Key

Query parameters

updatedSincestringOptional

offsetstringOptional

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

get

/v1/crm/customers/export

HTTPcURLJavaScriptPython

GET /v1/crm/customers/export HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "items": [
      {
        "firstName": "text",
        "lastName": "text",
        "email": "text",
        "phone": "text",
        "phoneCountry": "text",
        "phoneCountryCalling": "text",
        "number": "text",
        "cityId": "text",
        "birthDate": "text",
        "gender": {},
        "unsubscribed": true,
        "internalNote": "text",
        "archivedAt": "text",
        "archivedBy": "text",
        "archivedVia": "text",
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "id": "text"
      }
    ],
    "next": "text"
  }
}