Skip to main content
POST
/
api
/
v1
/
clients
Criar cliente
curl --request POST \
  --url https://upay-sistema-api.onrender.com/api/v1/clients \
  --header 'API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "email": "[email protected]",
  "document": "<string>",
  "phone": "<string>"
}
'
{
  "message": "<string>",
  "client": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "email": "[email protected]",
    "document": "<string>",
    "phone": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
API-Key
string
header
required

Chave de API obtida através do endpoint /api/credentials. Também aceita formato Bearer Token: Authorization: Bearer <api_key>

Body

application/json
​
name
string
required
Required string length: 3 - 255
​
email
string<email>
required
​
document
string | null
Required string length: 11 - 20
​
phone
string | null
Required string length: 10 - 20

Response

Cliente criado com sucesso

​
message
string
​
client
object