Venflow API
V1ClientesPor ID

Actualizar un cliente

PATCH
/v1/customers/{id}

Authorization

Api-Key<token>

Tu clave API privada (comienza con pvk_)

In: header

Organization<token>

Tu ID de organización

In: header

Path Parameters

idstring
Formatuuid

Request Body

address?string

Dirección del cliente (texto)

Lengthlength <= 500
company_name?string

Nombre de la empresa para clientes comerciales

Lengthlength <= 255
email?string

Correo electrónico del cliente

Formatemail
Lengthlength <= 255
external_id?string

Identificador externo para integración con otros sistemas

Lengthlength <= 255
last_name?string

Apellido del cliente (para personas naturales)

Length1 <= length <= 255
metadata?

Key-value pairs for storing your own information on this customer. They are merged into what is already stored: keys you do not mention are kept. Send a key with a null value to delete that key, or {} to delete them all. At most 50 keys; keys up to 40 characters, values up to 500, and 27000 characters across all keys and values. Do not store sensitive data here: it is not encrypted and is returned on reads.

Four key names are reserved by Venflow and rejected: checkoutMode, subscriptionId, obInvoiceId and billing_cycles; use a different name, such as externalId.

Propertiesproperties <= 50
name?string

Nombre completo del cliente o nombre de la empresa

Length1 <= length <= 255
phone?string

Número de teléfono del cliente

Lengthlength <= 20
tax_id?string

Número de identificación fiscal

Lengthlength <= 50
tax_id_type?string

Tipo de identificación fiscal: V (venezolano), E (extranjero), J (jurídico), P (pasaporte)

Value in"V" | "E" | "J" | "P"
tax_withholding_rate?number

Tasa de retención de impuestos como porcentaje entero (0-100)

Formatdouble
Range0 <= value <= 1

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://api.venflow.app/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "name": "Ana Sofía",    "phone": "+58414111111"  }'
{
  "address": "string",
  "company_name": "string",
  "created": 0.1,
  "email": "string",
  "external_id": "string",
  "id": "string",
  "is_active": true,
  "last_name": "string",
  "livemode": true,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "name": "string",
  "object": "customer",
  "phone": "string",
  "tax_id": {
    "type": "string",
    "value": "string"
  },
  "tax_withholding_rate": 0
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}

Obtener un cliente GET

Obtiene los detalles de un cliente existente. Proporciona el ID único del cliente y la API devolverá la información correspondiente.

Eliminar un cliente DELETE

Elimina permanentemente un cliente. Esta acción no se puede deshacer. También elimina inmediatamente la relación del cliente con tu organización.