Skip to main content
PATCH
/
customers
/
{customer_id}
Update Customer
curl --request PATCH \
  --url https://api.{your-broker}.slate-labs.com/customers/{customer_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "country": "<string>",
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sales_status_id": 123
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "<string>",
  "phone": "<string>",
  "phone_normalized": "<string>",
  "country": "<string>",
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sales_status_id": 123,
  "kyc_status_id": 123,
  "affiliate_id": "<string>",
  "campaign_id": "<string>",
  "funnel": "<string>",
  "affiliate_lead_id": "<string>",
  "manager_counter": 123,
  "reg_time": "2023-11-07T05:31:56Z",
  "last_login_at": "2023-11-07T05:31:56Z",
  "last_activity_at": "2023-11-07T05:31:56Z",
  "last_trade_at": "2023-11-07T05:31:56Z",
  "ftd_at": "2023-11-07T05:31:56Z",
  "is_deposited": true,
  "is_active": true,
  "first_name": "<string>",
  "last_name": "<string>",
  "full_name": "",
  "ftd_sales_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "owner": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "first_name": "<string>",
    "last_name": "<string>",
    "full_name": "<string>",
    "role_id": 123,
    "role_name": "<string>"
  },
  "last_deposit_at": "2023-11-07T05:31:56Z",
  "retention_status": "<string>",
  "risk_classification": "normal",
  "compliance_status": "<string>",
  "phone_country": "<string>",
  "kyc_country": "<string>",
  "kyc_provider": "<string>",
  "kyc_completed_at": "2023-11-07T05:31:56Z",
  "reg_ip": "<string>",
  "registration_source": "<string>",
  "force_password_change": false,
  "trading_accounts": []
}

Path Parameters

​
customer_id
string<uuid>
required

Body

application/json

For CRM agent updates — only fields agents are allowed to change.

NOTE: compliance_status and kyc_status_id are intentionally excluded. compliance_status can only be changed via dedicated compliance endpoints (freeze/unfreeze). kyc_status_id can only be changed via KYC verification processes.

​
phone
string | null
Maximum string length: 20
​
country
string | null
​
owner_id
string<uuid> | null
​
sales_status_id
integer | null

Response

Successful Response

​
id
string<uuid>
required
​
email
string
required
​
phone
string | null
required
​
phone_normalized
string | null
required
​
country
string | null
required
​
owner_id
string<uuid> | null
required
​
sales_status_id
integer | null
required
​
kyc_status_id
integer | null
required
​
affiliate_id
string | null
required
​
campaign_id
string | null
required
​
funnel
string | null
required
​
affiliate_lead_id
string | null
required
​
manager_counter
integer
required
​
reg_time
string<date-time>
required
​
last_login_at
string<date-time> | null
required
​
last_activity_at
string<date-time> | null
required
​
last_trade_at
string<date-time> | null
required
​
ftd_at
string<date-time> | null
required
​
is_deposited
boolean
required
​
is_active
boolean
required
​
first_name
string | null
​
last_name
string | null
​
full_name
string
default:""
​
ftd_sales_agent_id
string<uuid> | null
​
owner
UserInCustomerResponse · object

Slim user shape for embedding in CustomerResponse — avoids circular schemas.

​
last_deposit_at
string<date-time> | null
​
retention_status
string | null
​
risk_classification
string | null
default:normal
​
compliance_status
string | null
​
phone_country
string | null
​
kyc_country
string | null
​
kyc_provider
string | null
​
kyc_completed_at
string<date-time> | null
​
reg_ip
string | null
​
registration_source
string | null
​
force_password_change
boolean
default:false
​
trading_accounts
TradingAccountResponse · object[]