Endpoint is used to import existing clients from your system to Repsly.

Request definition

Keys that determine which records to update or insert are marked with a blue diamond :small-blue-diamond:, while the required keys are marked with a red triangle :small-red-triangle:

Any planned changes to existing endpoints are marked with an orange diamond :small-orange-diamond:.

Code​ :small-red-triangle: :small-blue-diamond:String (50)Unique client code.
Name :small-red-triangle:String (255)Client name
ActiveBooleanActive client
TagStringTags associated with this client (separated with commas)
TerritoryEach territory in hierarchy: String (80)Full territory path this client belongs to. The delimiter between territory levels is “​>​”(meaning that a territory in a two-level hierarchy is given as “​ParentTerritory>ChildTerritory​”) Important​: The full path must always be given in import data (and will be returned by the export).
If a non-existent territory is assigned to a client in the import data, the existing territory hierarchy will be expanded to accommodate the new territory.
RepresentativeCodeString (20)Unique representative code (assigned to thisclient)
RepresentativeNameString (80)Representative name (assigned to this client)
StreetAddressString (255)Client street address
ZIPString (20)Client ZIP code
ZIPExtString (20)Client ZIP extension
CityString (255)Client city
StateString (255)Client state
CountryString (255)Client country
EmailString (128)Client email address
PhoneString (128)Client phone number
MobileString (128)Client mobile phone number
WebsiteString (255)Client website
ContactNameString (255)Contact person name
ContactTitleString (50)Contact person title
NoteString (255)Additional client note
StatusTextClient status name in sales cycle
CustomFields\Item\FieldString (255)Custom field name
CustomFields\Item\ValueTextCustom field value
PriceLists\NameTextList of price list names connected to this client.

null and empty list doesn’t have the same meaning. In case a request has null value on this parameter system will ignore that parameter but in case it has empty list as parameter, system will break all connections between client and price lists.
AccountCodeTextCode of the account assigned to this client.

Will be deleted if empty.
Will be ignored if not sent in at all.

Response definition

CodeIntegerError identifier (0 = no errors)
MessageString (255)Response affirmative or error message

For a successful HTTP request (code 200), you will always receive a status response with Code equal to 0 (no error) and Message = “Client import job started asynchronously under ID: {ImportJobID}”, where {ImportJobID} is the key you can use to check the current status of the import.

To check the status of the import job you can use ​Import job status endpoint.

In case of a HTTP bad request (code 400), you will also receive a status response with Code not equal to 0 and a descriptive message. For incorrect format or other unhandled errors you will receive an HTMLRequest error page.