Path parameters

• id integer(int64) Required

  Numeric ID of the instance

  Minimum value is 1.

Responses

• 200 application/json

  Successful response

  Hide response attributes Show response attributes object

  • archiveReason string | null Required

    Archive reason

    Values are subscription or other. Default value is other.

  • channel object | null | array | boolean | integer | number | string

    Any of:

    object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null

    Channel

    Channel

    Channel

    Channel

    Channel

    Channel

  • closedConversations integer(int32) | null Required

    Closed conversations

    Default value is 0.

  • createdAt string(date-time)

    Created at

  • 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 or hardfail.

  • 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

  • fullName object | null | array | boolean | integer | number | string

    Any of:

    object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null

    Full name

    Full name

    Full name

    Full name

    Full name

    Full name

  • hasUnviewedAnnouncements boolean | null Required

    Has unviewed announcements

    Default value is false.

  • hash object | null | array | boolean | integer | number | string

    Any of:

    object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null

    Hash

    Hash

    Hash

    Hash

    Hash

    Hash

  • id integer(int32)

    Id

  • initials object | null | array | boolean | integer | number | string

    Any of:

    object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null

    Initials

    Initials

    Initials

    Initials

    Initials

    Initials

  • invitationStatus string | null Required

    Invitation status

    Values are notSent, sent, or accepted. Default value is notSent.

  • 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, or reseller. Default value is admin.

  • shippingNotifications boolean | null Required

    Shipping notifications

    Default value is true.

  • throttle boolean | null Required

    Throttle

    Default value is true.

  • throttleParity boolean | null

    Throttle parity

  • token string | null

    Token

  • updatedAt string(date-time)

    Updated at

  • vendorId integer(int32) | null

    Vendor