Create / Update Client

2min
POST
Request to create or update the Client.
If you want to update Client using POST method you need to fill information for guid field or systemId field in request body.
Example how to use custom values:
You need to specify it for example like this:
first value is guid of the custom field (for this case you can select all custom fields in this endpoint - https://tasker.stoplight.io/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1customfields~1clients/get ), and second is value of the custom field.
"customValues":
{
"f889fbe9-9d9b-3c8a-8549-e321ee7e3e34": "Custom Value",
"f889fbe9-9d9b-3c8a-8549-e321ee7e3e35": "Custom Value 2",
"f889fbe9-9d9b-3c8a-8549-e321ee7e3e38": "2"
}
AUTHENTICATION
Authorization
apiKey
FORM PARAMETERS
title
string
*
Client name
address
string
Client address
city
string
Client city
phone
string
Client phone number
email
string
Client E-mail
creditStatus
string
Credit status guid or systemId
companyVatCode
string
companyCode
string
note
string
systemId
string
Identifier from external system
guid
string
Identifier from Frontu
deleted
boolean
Mark if entity is archived (1) or active (0)
clientType
integer
1 - physical, 2 - juridical
customValues
string
JSON object for custom field data (for example "guid": "value")
reportEmails
string
It is a additional fields for the client emails
RESPONSES
201
Returned when successful
400
Data contains errors
object
Data contains errors
code
string
message
string
errors
object
Example: [object Object]
Curl
Python
PHP
Shell
C#
|
curl --location --request POST 'https://dev1.frontu.com/client/api/v2/clients' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--form 'title=""' \
--form 'address=""' \
--form 'city=""' \
--form 'phone=""' \
--form 'email=""' \
--form 'creditStatus=""' \
--form 'companyVatCode=""' \
--form 'companyCode=""' \
--form 'note=""' \
--form 'systemId=""' \
--form 'guid=""' \
--form 'deleted=""' \
--form 'clientType=""' \
--form 'customValues=""' \
--form 'reportEmails=""'
curl --location --request POST 'https://dev1.frontu.com/client/api/v2/clients' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--form 'title=""' \
--form 'address=""' \
--form 'city=""' \
--form 'phone=""' \
--form 'email=""' \
--form 'creditStatus=""' \
--form 'companyVatCode=""' \
--form 'companyCode=""' \
--form 'note=""' \
--form 'systemId=""' \
--form 'guid=""' \
--form 'deleted=""' \
--form 'clientType=""' \
--form 'customValues=""' \
--form 'reportEmails=""'
RESPONSES
201
400
|
// Returned when successful 

// Returned when successful 
﻿
﻿
Updated 31 Jul 2023
Did this page help you?
Get Client list
Get Client detail information
Docs powered by
Archbee
Main

Create / Update Client
