Atualizar um cliente

curl --request POST \
  --url https://api.hubfy.io/v1/customers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "reference": "exemplo"
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({metadata: {reference: 'exemplo'}})
};

fetch('https://api.hubfy.io/v1/customers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.hubfy.io/v1/customers/{id}"

payload = { "metadata": { "reference": "exemplo" } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "cus_1234567890abcdef",
  "city": null,
  "country": null,
  "created_at": "2030-01-01T00:00:00.000Z",
  "currency": "BRL",
  "document": null,
  "document_type": null,
  "email": "cliente@example.com",
  "email_marketing_status": "subscribed",
  "external_id": null,
  "first_name": null,
  "last_name": null,
  "metadata": {},
  "mrr_cents": 0,
  "name": "Cliente Exemplo",
  "object": "customer",
  "phone": null,
  "region": null,
  "total_revenue_cents": 0,
  "updated_at": "2030-01-01T00:00:00.000Z"
}

{
  "error": {
    "code": "invalid_parameter",
    "doc_url": null,
    "message": "The request contains invalid parameters",
    "param": null,
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "doc_url": null,
    "message": "The request contains invalid parameters",
    "param": null,
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "doc_url": null,
    "message": "The request contains invalid parameters",
    "param": null,
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "doc_url": null,
    "message": "The request contains invalid parameters",
    "param": null,
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "doc_url": null,
    "message": "The request contains invalid parameters",
    "param": null,
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "doc_url": null,
    "message": "The request contains invalid parameters",
    "param": null,
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "doc_url": null,
    "message": "The request contains invalid parameters",
    "param": null,
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "doc_url": null,
    "message": "The request contains invalid parameters",
    "param": null,
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "doc_url": null,
    "message": "The request contains invalid parameters",
    "param": null,
    "type": "invalid_request_error"
  }
}

POST

customers

{id}

Atualizar um cliente

curl --request POST \
  --url https://api.hubfy.io/v1/customers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "reference": "exemplo"
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({metadata: {reference: 'exemplo'}})
};

fetch('https://api.hubfy.io/v1/customers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.hubfy.io/v1/customers/{id}"

payload = { "metadata": { "reference": "exemplo" } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "cus_1234567890abcdef",
  "city": null,
  "country": null,
  "created_at": "2030-01-01T00:00:00.000Z",
  "currency": "BRL",
  "document": null,
  "document_type": null,
  "email": "cliente@example.com",
  "email_marketing_status": "subscribed",
  "external_id": null,
  "first_name": null,
  "last_name": null,
  "metadata": {},
  "mrr_cents": 0,
  "name": "Cliente Exemplo",
  "object": "customer",
  "phone": null,
  "region": null,
  "total_revenue_cents": 0,
  "updated_at": "2030-01-01T00:00:00.000Z"
}

{
  "error": {
    "code": "invalid_parameter",
    "doc_url": null,
    "message": "The request contains invalid parameters",
    "param": null,
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "doc_url": null,
    "message": "The request contains invalid parameters",
    "param": null,
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "doc_url": null,
    "message": "The request contains invalid parameters",
    "param": null,
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "doc_url": null,
    "message": "The request contains invalid parameters",
    "param": null,
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "doc_url": null,
    "message": "The request contains invalid parameters",
    "param": null,
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "doc_url": null,
    "message": "The request contains invalid parameters",
    "param": null,
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "doc_url": null,
    "message": "The request contains invalid parameters",
    "param": null,
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "doc_url": null,
    "message": "The request contains invalid parameters",
    "param": null,
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "doc_url": null,
    "message": "The request contains invalid parameters",
    "param": null,
    "type": "invalid_request_error"
  }
}

Atualiza dados de contato, identificação, preferências, external_id e metadata. Os indicadores financeiros e currency são somente leitura. Requer customers:write ou write. Use Idempotency-Key ao repetir a mesma operação. Veja campos, relacionamentos e eventos.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

Chave única por operação lógica, de 1 a 255 caracteres ASCII imprimíveis, sem espaços. Reutilize-a somente para repetir a mesma operação.

Required string length: 1 - 255

Path Parameters

string

required

ID público do cliente na conta.

Pattern: ^cus_[a-z0-9]{16}$

Body

application/json

city

string | null

Cidade do cliente; null quando ausente.

Maximum string length: 10000

country

string | null

País informado no cadastro; null quando ausente.

Maximum string length: 10000

document

string | null

Documento do cliente como string, preservando zeros à esquerda; null quando ausente.

Maximum string length: 10000

document_type

string | null

Tipo do documento informado, como cpf ou cnpj; null quando ausente.

Maximum string length: 10000

string

Email do cliente. Obrigatório e não vazio na criação; convertido para minúsculas ao criar.

Required string length: 1 - 10000

email_marketing_status

string | null

Situação de email marketing: subscribed, unsubscribed, archived, requires_verification, invalid_email ou bounced.

Maximum string length: 10000

external_id

string | null

Identificador do cliente no seu sistema. Pode ser null. Não substitui o id da Hubfy.

Maximum string length: 10000

first_name

string | null

Primeiro nome; null quando ausente.

Maximum string length: 10000

last_name

string | null

Sobrenome; null quando ausente.

Maximum string length: 10000

metadata

object

Objeto JSON livre para referências da integração, limitado a 16 KB. Ao enviar, substitui todo o metadata anterior; use {} para limpar. Não aceita null.

name

string

Nome do cliente. Obrigatório e não vazio na criação.

Required string length: 1 - 10000

phone

string | null

Telefone do cliente como string; null quando ausente.

Maximum string length: 10000

region

string | null

Estado ou região do cliente; null quando ausente.

Maximum string length: 10000

Response

Operação concluída

string

required

Identificador público estável. Use o valor retornado pela API nas consultas e relacionamentos; não derive IDs de nomes.

Pattern: ^cus_[a-z0-9]{16}$

city

string | null

required

Cidade do cliente; null quando ausente.

country

string | null

required

País informado no cadastro; null quando ausente.

created_at

string<date-time>

required

Data e hora da criação, em ISO 8601 com fuso horário. Somente leitura.

currency

string | null

required

Moeda dos indicadores do cliente. Pode ser null. Somente leitura.

document

string | null

required

Documento do cliente como string, preservando zeros à esquerda; null quando ausente.

document_type

string | null

required

Tipo do documento informado, como cpf ou cnpj; null quando ausente.

string | null

required

Email do cliente. Obrigatório e não vazio na criação; convertido para minúsculas ao criar.

email_marketing_status

string | null

required

Situação de email marketing: subscribed, unsubscribed, archived, requires_verification, invalid_email ou bounced.

external_id

string | null

required

Identificador do cliente no seu sistema. Pode ser null. Não substitui o id da Hubfy.

first_name

string | null

required

Primeiro nome; null quando ausente.

last_name

string | null

required

Sobrenome; null quando ausente.

metadata

object

required

Objeto JSON livre para referências da integração, limitado a 16 KB. Ao enviar, substitui todo o metadata anterior; use {} para limpar. Não aceita null.

mrr_cents

integer

required

Receita recorrente mensal registrada para o cliente, em centavos. Somente leitura.

name

string | null

required

Nome do cliente. Obrigatório e não vazio na criação.

object

string

required

Tipo do objeto retornado. O valor é fixo para este recurso.

Allowed value: "customer"

phone

string | null

required

Telefone do cliente como string; null quando ausente.

region

string | null

required

Estado ou região do cliente; null quando ausente.

total_revenue_cents

integer

required

Receita acumulada registrada para o cliente, em centavos. Não deve ser enviada em criação ou atualização.

updated_at

string<date-time>

required

Data e hora da última alteração, em ISO 8601 com fuso horário. Somente leitura.

Fundamentos da API

Objetos

Webhooks e eventos

Atualizar um cliente

Authorizations

Headers

Path Parameters

Body

Response