Update a client

PUT/clients/{clientId}Update a client

Updates the provided fields; omitted fields are left unchanged. Cross- tenant updates return 404 not_found (no existence leak).

Parameters

clientIdstring · uuidpathrequired

Client UUID.

Request body

required

application/json

objectUpdateClientRequest

PATCH-style update — only the fields present in the body are touched. Any unknown fields are ignored.

accountManagerIdsarray of string · uuid

Full-replacement set of account-manager user IDs. Omit to leave the existing assignments untouched. Pass an empty array to clear all assignments. Pass a populated array to replace the entire assignment set. Each ID is validated for org membership; cross-tenant assignment returns `400 invalid_argument` with the offending ID in the message.

Show child attributes

clientTypestring

Optional new lifecycle stage. Omit to leave the stored value untouched (no silent default on update). Invalid values return `400 invalid_argument` naming the offending value.

one of "prospect", "active", "churned"

domainstring

New email domain. Passing an empty string clears the domain.

namestring

New display name.

Example request

{
  "accountManagerIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "clientType": "churned",
  "domain": "string",
  "name": "string"
}

Responses

Headers

X-RateLimit-Limit

The request cap for the tighter of the per-organization / per-endpoint windows that applied to this request.

X-RateLimit-Remaining

Requests remaining in the current window.

X-RateLimit-Reset

Unix timestamp (seconds) when the current window resets.

value

allOf · 2 options

Option 1objectEnvelope

datavaluerequired

The response payload — shape depends on the endpoint.

metaobjectrequired

Pagination metadata — populated on list endpoints, empty on single-resource endpoints.

Show child attributes

cursornull | string

Opaque cursor to pass to the next request.

hasMoreboolean | null

True when further pages of results are available.

Option 2object

dataobject

A client record (partner's CRM account / customer). The fields `email`, `phone`, `company`, and `notes` from the v1.0 spec document are not yet populated — tracked as a follow-up.

Show child attributes

accountManagersarray of objectrequired

Users assigned as account managers for this client. Peers — no primary/secondary distinction. Always present; an empty array signals no managers are assigned.

Show child attributes

Show array items

Minimal user identity surfaced on client records.

emailstring · emailrequired

firstNamestringrequired

lastNamestringrequired

userIdstring · uuidrequired

Stable UUID for this user.

clientTypestringrequired

Lifecycle stage of the client (status, not legal entity type). `prospect` → `active` → `churned` is the canonical progression. Use this to answer pipeline/status questions ("who are my prospects?", "who has churned?"). Defaults to `active` on creation when the caller omits the field.

one of "prospect", "active", "churned"

createdAtstring · date-timerequired

UTC timestamp when the client was created.

domainnull | string

Primary email domain used to auto-assign communications (e.g. `acme.com`).

idstring · uuidrequired

Stable UUID for this client.

namestringrequired

Display name of the client.

updatedAtstring · date-timerequired

UTC timestamp of the most recent update.

Example response

{
  "data": {
    "accountManagers": [
      {
        "email": "user@example.com",
        "firstName": "string",
        "lastName": "string",
        "userId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "clientType": "active",
    "createdAt": "2026-06-09T00:00:00Z",
    "domain": "acme.com",
    "id": "8b2d1c4e-3f5a-4e2b-9c8f-1e2d3c4b5a6f",
    "name": "Acme Corp",
    "updatedAt": "2026-06-09T00:00:00Z"
  },
  "meta": {
    "cursor": "string",
    "hasMore": true
  }
}

objectErrorEnvelope

errorobjectrequired

Show child attributes

codestringrequired

Machine-readable error category.

one of "unauthorized", "forbidden", "not_found", "invalid_argument", "conflict", "rate_limited", "internal_error", "not_implemented"

detailsobject

Optional per-code context (field names, retry windows, …).

messagestringrequired

Human-readable description — intended for operator logs, not end-user display.

Example response

{
  "error": {
    "code": "invalid_argument",
    "message": "limit must be an integer between 1 and 100"
  }
}

objectErrorEnvelope

errorobjectrequired

Show child attributes

codestringrequired

Machine-readable error category.

one of "unauthorized", "forbidden", "not_found", "invalid_argument", "conflict", "rate_limited", "internal_error", "not_implemented"

detailsobject

Optional per-code context (field names, retry windows, …).

messagestringrequired

Human-readable description — intended for operator logs, not end-user display.

Example response

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication required"
  }
}

objectErrorEnvelope

errorobjectrequired

Show child attributes

codestringrequired

Machine-readable error category.

one of "unauthorized", "forbidden", "not_found", "invalid_argument", "conflict", "rate_limited", "internal_error", "not_implemented"

detailsobject

Optional per-code context (field names, retry windows, …).

messagestringrequired

Human-readable description — intended for operator logs, not end-user display.

Example response

{
  "error": {
    "code": "not_found",
    "message": "client not found"
  }
}

Headers

Retry-After

Seconds the client should wait before retrying.

objectErrorEnvelope

errorobjectrequired

Show child attributes

codestringrequired

Machine-readable error category.

one of "unauthorized", "forbidden", "not_found", "invalid_argument", "conflict", "rate_limited", "internal_error", "not_implemented"

detailsobject

Optional per-code context (field names, retry windows, …).

messagestringrequired

Human-readable description — intended for operator logs, not end-user display.

Example response

{
  "error": {
    "code": "rate_limited",
    "details": {
      "retry_after_seconds": 30
    },
    "message": "Rate limit exceeded"
  }
}

Examples

clientIdrequiredpath parameter

curl -X PUT 'https://api.salfio.com/v1/clients/00000000-0000-0000-0000-000000000000' \
  -H 'Content-Type: application/json' \
  -d '{"accountManagerIds":["00000000-0000-0000-0000-000000000000"],"clientType":"churned","domain":"string","name":"string"}'

const response = await fetch('https://api.salfio.com/v1/clients/00000000-0000-0000-0000-000000000000', {
  method: 'PUT',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"accountManagerIds":["00000000-0000-0000-0000-000000000000"],"clientType":"churned","domain":"string","name":"string"}),
});
const data = await response.json();

const response = await fetch('https://api.salfio.com/v1/clients/00000000-0000-0000-0000-000000000000', { method: 'PUT', headers: { 'Content-Type': 'application/json' }, body: "{\"accountManagerIds\":[\"00000000-0000-0000-0000-000000000000\"],\"clientType\":\"churned\",\"domain\":\"string\",\"name\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "PUT",
    "https://api.salfio.com/v1/clients/00000000-0000-0000-0000-000000000000",
    headers={"Content-Type": "application/json"},
    data='{"accountManagerIds":["00000000-0000-0000-0000-000000000000"],"clientType":"churned","domain":"string","name":"string"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"accountManagerIds":["00000000-0000-0000-0000-000000000000"],"clientType":"churned","domain":"string","name":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "PUT", "https://api.salfio.com/v1/clients/00000000-0000-0000-0000-000000000000", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.salfio.com/v1/clients/00000000-0000-0000-0000-000000000000");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"accountManagerIds\":[\"00000000-0000-0000-0000-000000000000\"],\"clientType\":\"churned\",\"domain\":\"string\",\"name\":\"string\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.salfio.com/v1/clients/00000000-0000-0000-0000-000000000000"))
    .method("PUT", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString("{\"accountManagerIds\":[\"00000000-0000-0000-0000-000000000000\"],\"clientType\":\"churned\",\"domain\":\"string\",\"name\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.salfio.com/v1/clients/00000000-0000-0000-0000-000000000000")
request = Net::HTTPGenericRequest.new("PUT", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"accountManagerIds\":[\"00000000-0000-0000-0000-000000000000\"],\"clientType\":\"churned\",\"domain\":\"string\",\"name\":\"string\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Put, "https://api.salfio.com/v1/clients/00000000-0000-0000-0000-000000000000");
request.Content = new StringContent("{\"accountManagerIds\":[\"00000000-0000-0000-0000-000000000000\"],\"clientType\":\"churned\",\"domain\":\"string\",\"name\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "data": {
    "accountManagers": [
      {
        "email": "user@example.com",
        "firstName": "string",
        "lastName": "string",
        "userId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "clientType": "active",
    "createdAt": "2026-06-09T00:00:00Z",
    "domain": "acme.com",
    "id": "8b2d1c4e-3f5a-4e2b-9c8f-1e2d3c4b5a6f",
    "name": "Acme Corp",
    "updatedAt": "2026-06-09T00:00:00Z"
  },
  "meta": {
    "cursor": "string",
    "hasMore": true
  }
}

{
  "error": {
    "code": "invalid_argument",
    "message": "limit must be an integer between 1 and 100"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication required"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "client not found"
  }
}

{
  "error": {
    "code": "rate_limited",
    "details": {
      "retry_after_seconds": 30
    },
    "message": "Rate limit exceeded"
  }
}

Search documentation

Parameters

Request body

Responses

Headers

Headers

Documentation menu