✏️ Update client details

Requête

Update client details.

This endpoint allows you to update an existing client's information. Only the fields provided in the request will be updated; fields not included will remain unchanged.

Note: When updating external_ref, ensure it's unique for this sponsor.

Sécurité

APIKeyHeader

Chemin

client_idstring(Client Id)obligatoire

Corpsapplication/jsonobligatoire

organization_namestring or null(Organization Name)

Any of:

Name of the organization

[ 1 .. 255 ] characters

string

contact_emailstring or null(Contact Email)

Any of:

Contact email for the organization

<= 255 characters

string

external_refstring or null(External Ref)

Any of:

External reference identifier

[ 1 .. 100 ] characters

string

statusClientStatus (string) or null

Any of:

Status of the client.

string(ClientStatus)

Enum:"active""inactive""pending""suspended"

curl -i -X PUT \
  'https://pdp.seqino.dev/api/clients/{client_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "organization_name": "Acme Corporation",
    "contact_email": "contact@acme.com",
    "external_ref": "EXT-12345",
    "status": "active"
  }'

Réponses

Client updated successfully

Corpsapplication/json

client_idstring(Client Id)

Unique client identifier

organization_namestring(Organization Name)obligatoire

Name of the organization

contact_emailstring(Contact Email)obligatoire

Contact email for the organization

external_refstring(External Ref)obligatoire

External reference identifier

sponsor_idstring(Sponsor Id)obligatoire

PDP sponsor ID from the X-PDP-Sponsor-Id header

statusstring(ClientStatus)obligatoire

Current status of the client

Enum:"active""inactive""pending""suspended"

created_atstring, (date-time)(Created At)obligatoire

When the client was created

updated_atstring or null(Updated At)

Any of:

When the client was last updated

string (date-time)

Response

{
  "client_id": "string",
  "organization_name": "string",
  "contact_email": "string",
  "external_ref": "string",
  "sponsor_id": "string",
  "status": "active",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}