Skip to content
Sales persons/
Upload list of sales pers...

Upload list of sales persons

Request

POST https://api.zoined.com/salesPersons?dryRun=false&separator=%3B&encoding=utf-8

Security
bearerAuth
Query
dryRunbooleanrequired

Only validate the request without storing the data

Example:dryRun=false
separatorstringrequired

Column separator used when loading CSV data

Example:separator=;
encodingstringrequired

Character encoding used in the CSV data (default is utf-8)

Example:encoding=utf-8
Body
Any of:
salesperson_idstringrequired

Sales person ID

Example:"5402101"
salesperson_namestring

Sales person name

Example:"John Smith"
salesperson_emailstring

Sales person email

Example:"john.smith@store.store"
salesperson_phonestring

Sales person phone number

Example:"+35811111111"
employee_idstring

Employee id

Example:"353"
employment_startstring

Employment start date

Example:"2020-01-01"
employment_endstring

Employment end date

Example:"2020-05-31"
custom_field_1string

Custom field 1

Example:"Project worker"
custom_field_2string

Custom field 2

Example:"Project worker"
custom_field_3string

Custom field 3

Example:"Project worker"
custom_field_4string

Custom field 4

Example:"Project worker"
custom_field_5string

Custom field 5

Example:"Project worker"
custom_metric_1number

Custom metric 1

Example:1
custom_metric_2number

Custom metric 2

Example:100
custom_metric_3number

Custom metric 3

Example:2.2
custom_metric_4number

Custom metric 4

Example:1.05
custom_metric_5number

Custom metric 5

Example:10000
source_systemstring

Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.

Example:"ABCDEF"
curl -i -X POST \
  'https://zapi-api.zoined.com/_mock/salesPersons?dryRun=false&separator=%3B&encoding=utf-8' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "salesperson_id": "5402101",
    "salesperson_name": "John Smith",
    "salesperson_email": "john.smith@store.store",
    "salesperson_phone": "+35811111111",
    "employee_id": "353",
    "employment_start": "2020-01-01",
    "employment_end": "2020-05-31",
    "custom_field_1": "Project worker",
    "custom_field_2": "Project worker",
    "custom_field_3": "Project worker",
    "custom_field_4": "Project worker",
    "custom_field_5": "Project worker",
    "custom_metric_1": 1,
    "custom_metric_2": 100,
    "custom_metric_3": 2.2,
    "custom_metric_4": 1.05,
    "custom_metric_5": 10000,
    "source_system": "ABCDEF"
  }'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
statusstringrequired

Status of the operation OK / Not OK

Example:"OK"
msgstringrequired

Message describing result of operation

Example:"1 entity added"
Response
{
  "status": "OK",
  "msg": "1 entity added"
}