Update a patient

Updates basic information of an existing patient.

Requires the patients:write permission.

PUT/patients/{patient_id}

Autorización

AuthorizationToken Bearer (API Key) · headerobligatorio

Almendra API key, bound to one professional account. Send it as Authorization: Bearer YOUR_API_KEY.

Ámbitos:patients:write

Parámetros de ruta

patient_idstringobligatorio

Patient ID

coincide con ^[0-9a-fA-F]{24}$

Cuerpo de la solicitud

application/json

firstNamestring

Patient first name

longitud mín. 1

lastNamestring

Patient last name

longitud mín. 1

emailstring<email>

Patient email

phonestring

Patient phone number

nationalitystring

Patient nationality

addressstring

Patient address

birthdatestring<date-time>

Patient birthdate in ISO 8601 format

idNumberstring

Patient ID number (e.g., SSN, passport)

occupationstring

Patient occupation

sexstring

Patient sex

Valores permitidos:MF

Respuestas

200

Patient updated successfully

_idstringobligatorio

firstNamestringobligatorio

lastNamestringobligatorio

emailstring<email>

phonestring

nationalitystring

addressobject[]

Mostrar propiedades

Array de object

valuestringobligatorio

timestampstring<date-time>obligatorio

birthdatestring<date-time>

idNumberstring

occupationstring

sexstringobligatorio

Valores permitidos:malefemaleother

expertstringobligatorio

createdAtstring<date-time>obligatorio

updatedAtstring<date-time>obligatorio

400

Bad request - Invalid input

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

Valores permitidos:bad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictpayload_too_largeunsupported_media_typeunprocessable_entityrate_limitedinternal_errornot_implementedbad_gatewayservice_unavailablegateway_timeout

messagestringobligatorio

Human-readable explanation of what went wrong.

401

Unauthorized - Invalid API key

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

403

The account behind the API key has no active paid plan, or the key lacks the permission this operation needs

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

404

Patient not found

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

415

Unsupported Media Type - send the body as JSON with Content-Type: application/json

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

429

Rate limit exceeded (600 requests per 60 seconds); retry after Retry-After seconds

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

500

Unexpected server error

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

Pruébalo

Servidor

URL baseURL base personalizadaSi se define, sustituye al servidor seleccionado.

Autorización

Token Bearer (API Key)Recordar en este dispositivoIncluir mis valores en los ejemplos

Parámetros

patient_idpath*Patient ID

Cuerpoapplication/json

firstNamestringPatient first namelastNamestringPatient last nameemailstringPatient emailphonestringPatient phone numbernationalitystringPatient nationalityaddressstringPatient addressbirthdatestringPatient birthdate in ISO 8601 formatidNumberstringPatient ID number (e.g., SSN, passport)occupationstringPatient occupationsexstringPatient sex

Solicitud

curl -X PUT 'https://api.almendra.io/openapi/v1/patients/507f1f77bcf86cd799439011' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phone": "+1234567890",
  "nationality": "American",
  "address": "123 Main St, City, State 12345",
  "birthdate": "1990-01-15T00:00:00.000Z",
  "idNumber": "123456789",
  "occupation": "Software Engineer",
  "sex": "M"
}'

const response: Response = await fetch("https://api.almendra.io/openapi/v1/patients/507f1f77bcf86cd799439011", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"email\": \"john.doe@example.com\",\n  \"phone\": \"+1234567890\",\n  \"nationality\": \"American\",\n  \"address\": \"123 Main St, City, State 12345\",\n  \"birthdate\": \"1990-01-15T00:00:00.000Z\",\n  \"idNumber\": \"123456789\",\n  \"occupation\": \"Software Engineer\",\n  \"sex\": \"M\"\n}"
});

import axios from "axios";

const response = await axios.request({
  method: "PUT",
  url: "https://api.almendra.io/openapi/v1/patients/507f1f77bcf86cd799439011",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  data: "{\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"email\": \"john.doe@example.com\",\n  \"phone\": \"+1234567890\",\n  \"nationality\": \"American\",\n  \"address\": \"123 Main St, City, State 12345\",\n  \"birthdate\": \"1990-01-15T00:00:00.000Z\",\n  \"idNumber\": \"123456789\",\n  \"occupation\": \"Software Engineer\",\n  \"sex\": \"M\"\n}"
});

import requests

response = requests.put(
    "https://api.almendra.io/openapi/v1/patients/507f1f77bcf86cd799439011",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"email\": \"john.doe@example.com\",\n  \"phone\": \"+1234567890\",\n  \"nationality\": \"American\",\n  \"address\": \"123 Main St, City, State 12345\",\n  \"birthdate\": \"1990-01-15T00:00:00.000Z\",\n  \"idNumber\": \"123456789\",\n  \"occupation\": \"Software Engineer\",\n  \"sex\": \"M\"\n}",
)

Respuesta

{
  "_id": "507f1f77bcf86cd799439011",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phone": "+1234567890",
  "nationality": "American",
  "address": [
    {
      "value": "123 Main St, City, State 12345",
      "timestamp": "2024-01-15T00:00:00.000Z"
    }
  ],
  "birthdate": "1990-01-15T00:00:00.000Z",
  "idNumber": "123456789",
  "occupation": "Software Engineer",
  "sex": "male",
  "expert": "507f1f77bcf86cd799439012",
  "createdAt": "2024-01-15T00:00:00.000Z",
  "updatedAt": "2024-01-15T00:00:00.000Z"
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

Update a patient

¿No encuentras lo que buscas?