Pular para o conteúdo principal
POST
/
client
Create a Client
curl --request POST \
  --url https://api.cliquepay.app/client \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Cliente Bola",
  "status": "ACTIVE",
  "cpfCnpj": "05305405364",
  "email": "bola@email.com",
  "phone": "41999999999",
  "companyId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
  "address": "Rua Engenheiros Rebouças",
  "district": "Rebouças",
  "number": "2000",
  "postalCode": "80215100",
  "line1": "Green apartment"
}'
{
  "id": "0502ef53-ddc3-429b-b480-01cb1bbd81e0",
  "cpfCnpj": "05305405364",
  "name": "Cliente Bola",
  "email": "bola@email.com",
  "phone": "41999999999",
  "status": "ACTIVE",
  "companyId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
  "createdAt": "2025-02-03T10:00:00Z",
  "updatedAt": "2025-02-03T10:00:00Z"
}

Body

application/json
​
name
string
required

Client Name

Example:

"Cliente Bola"

​
status
string
required

Client status

Example:

"ACTIVE"

​
cpfCnpj
string
required

Client id

Example:

"05305405364"

​
email
string
required

Client Email

Example:

"bola@email.com"

​
phone
string
required

Client Phone

Example:

"41999999999"

​
companyId
string

Company id

Example:

"f96a489c-8a4d-4c7b-a1f6-347acbd832df"

​
address
string

Client street

Example:

"Rua Engenheiros Rebouças"

​
district
string

Client district

Example:

"Rebouças"

​
number
string

Client house number

Example:

"2000"

​
postalCode
string

Client postal code

Example:

"80215100"

​
line1
string

Client address complement

Example:

"Green apartment"

Response

201 - application/json

Client created

​
id
string
required

Client id

Example:

"0502ef53-ddc3-429b-b480-01cb1bbd81e0"

​
cpfCnpj
string
required

Client id

Example:

"05305405364"

​
name
string
required

Client Name

Example:

"Cliente Bola"

​
email
string
required

Client Email

Example:

"bola@email.com"

​
phone
string
required

Client Phone

Example:

"41999999999"

​
status
string
required

Client Status

Example:

"ACTIVE"

​
companyId
string
required

Company id

Example:

"f96a489c-8a4d-4c7b-a1f6-347acbd832df"

​
createdAt
string<date-time>
required

Client created at date

Example:

"2025-02-03T10:00:00Z"

​
updatedAt
string<date-time>
required

Client updated at date

Example:

"2025-02-03T10:00:00Z"

⌘I