POST /users.json
Body Required
-
closedConversations integer(int32) | null Required
Closed conversations
Default value is
0
. -
credentialCycles integer(int32) | null Required
Credential cycles
Default value is
0
. -
customerId integer(int32) | null
Customer
-
dropDescription string | null
Drop description
-
dropReason string | null
Drop reason
Values are
old
orhardfail
. -
droppedAt string(date-time) | null
Dropped at
-
dropshipProviderId integer(int32) | null
Dropship provider
-
email string Required
Email
-
emailExport boolean | null Required
Email export
Default value is
true
. -
emailSet boolean | null Required
Email set
Default value is
true
. -
enabled boolean | null Required
Enabled
Default value is
true
. -
firstName string | null
First name
-
hasUnviewedAnnouncements boolean | null Required
Has unviewed announcements
Default value is
false
. -
invitationStatus string | null Required
Invitation status
Values are
notSent
,sent
, oraccepted
. Default value isnotSent
. -
invoicingNotifications boolean | null
Invoicing notifications
-
lastName string | null
Last name
-
limitConsumption integer(int32) | null
Limit consumption
-
openConversations integer(int32) | null Required
Open conversations
Default value is
0
. -
partnerId integer(int32) | null
Partner
-
password string Required
Password
-
passwordSet boolean Required
Password set
Default value is
true
. -
profileImage string | null
Profile image
-
resellerId integer(int32) | null
Reseller
-
resetToken string | null
Reset token
-
role string | null Required
Role
Values are
accounting
,admin
,api
,manager
,partner
,shipping
,vendor
,customer
,dropship_provider
, orreseller
. Default value isadmin
. -
shippingNotifications boolean | null Required
Shipping notifications
Default value is
true
. -
throttle boolean | null Required
Throttle
Default value is
true
. -
token string | null
Token
-
vendorId integer(int32) | null
Vendor
curl \
-X POST http://api.example.com/v1/users.json \
-H "Content-Type: application/json" \
-d '{"channel":{},"closedConversations":0,"credentialCycles":0,"customerId":42,"dropDescription":"string","dropReason":"old","droppedAt":"2023-05-04T09:42:00+00:00","dropshipProviderId":42,"email":"string","emailExport":true,"emailSet":true,"enabled":true,"firstName":"string","fullName":{},"hasUnviewedAnnouncements":false,"hash":{},"initials":{},"invitationStatus":"notSent","invoicingNotifications":true,"lastName":"string","limitConsumption":42,"openConversations":0,"partnerId":42,"password":"string","passwordSet":true,"profileImage":"string","resellerId":42,"resetToken":"string","role":"admin","shippingNotifications":true,"throttle":true,"token":"string","vendorId":42}'
{
"channel": {},
"closedConversations": 0,
"credentialCycles": 0,
"customerId": 42,
"dropDescription": "string",
"dropReason": "old",
"droppedAt": "2023-05-04T09:42:00+00:00",
"dropshipProviderId": 42,
"email": "string",
"emailExport": true,
"emailSet": true,
"enabled": true,
"firstName": "string",
"fullName": {},
"hasUnviewedAnnouncements": false,
"hash": {},
"initials": {},
"invitationStatus": "notSent",
"invoicingNotifications": true,
"lastName": "string",
"limitConsumption": 42,
"openConversations": 0,
"partnerId": 42,
"password": "string",
"passwordSet": true,
"profileImage": "string",
"resellerId": 42,
"resetToken": "string",
"role": "admin",
"shippingNotifications": true,
"throttle": true,
"token": "string",
"vendorId": 42
}
{
"channel": {},
"closedConversations": 0,
"createdAt": "2023-05-04T09:42:00+00:00",
"credentialCycles": 0,
"customerId": 42,
"dropDescription": "string",
"dropReason": "old",
"droppedAt": "2023-05-04T09:42:00+00:00",
"dropshipProviderId": 42,
"email": "string",
"emailExport": true,
"emailSet": true,
"enabled": true,
"firstName": "string",
"fullName": {},
"hasUnviewedAnnouncements": false,
"hash": {},
"id": 42,
"initials": {},
"invitationStatus": "notSent",
"invoicingNotifications": true,
"lastName": "string",
"limitConsumption": 42,
"openConversations": 0,
"partnerId": 42,
"password": "string",
"passwordSet": true,
"profileImage": "string",
"resellerId": 42,
"resetToken": "string",
"role": "admin",
"shippingNotifications": true,
"throttle": true,
"token": "string",
"updatedAt": "2023-05-04T09:42:00+00:00",
"vendorId": 42
}