Skip to main content
POST
Register rep account

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

The rep ID.

Body

application/json
customer_identity
object | null
permissions
enum<string>[]
  • authentication.repuser.view_all_entities - authentication.repuser.view_all_entities
  • authentication.repuser.view_downline_entities - authentication.repuser.view_downline_entities
  • authentication.repuser.view_timeline - authentication.repuser.view_timeline
  • authentication.repuser.view_timeline_staff_comments - authentication.repuser.view_timeline_staff_comments
  • commission.commission.view_commission - commission.commission.view_commission
  • portal.draftorder.edit_draft_line_level_discounts - portal.draftorder.edit_draft_line_level_discounts
  • portal.draftorder.edit_draft_order_addresses - portal.draftorder.edit_draft_order_addresses
  • portal.draftorder.edit_draft_order_level_custom_discount - portal.draftorder.edit_draft_order_level_custom_discount
  • portal.draftorder.edit_draft_order_level_discount_codes - portal.draftorder.edit_draft_order_level_discount_codes
  • portal.draftorder.edit_payment_terms - portal.draftorder.edit_payment_terms
  • portal.draftorder.use_admin_approval_flow - portal.draftorder.use_admin_approval_flow
  • portal.draftorder.use_customer_approval_flow - portal.draftorder.use_customer_approval_flow
  • portal.draftorder.use_customer_impersonation_flow - portal.draftorder.use_customer_impersonation_flow
  • shopify.shopifycompany.create_companies - shopify.shopifycompany.create_companies
  • shopify.shopifycompanylocation.create_company_locations - shopify.shopifycompanylocation.create_company_locations
  • shopify.shopifycustomer.create_customers - shopify.shopifycustomer.create_customers
  • shopify.shopifycustomeraddress.edit_customer_addresses - shopify.shopifycustomeraddress.edit_customer_addresses
Available options:
authentication.repuser.view_all_entities,
authentication.repuser.view_downline_entities,
authentication.repuser.view_timeline,
authentication.repuser.view_timeline_staff_comments,
commission.commission.view_commission,
portal.draftorder.edit_draft_line_level_discounts,
portal.draftorder.edit_draft_order_addresses,
portal.draftorder.edit_draft_order_level_custom_discount,
portal.draftorder.edit_draft_order_level_discount_codes,
portal.draftorder.edit_payment_terms,
portal.draftorder.use_admin_approval_flow,
portal.draftorder.use_customer_approval_flow,
portal.draftorder.use_customer_impersonation_flow,
shopify.shopifycompany.create_companies,
shopify.shopifycompanylocation.create_company_locations,
shopify.shopifycustomer.create_customers,
shopify.shopifycustomeraddress.edit_customer_addresses

Response

id
string<uuid>
required
read-only
name
string
required
email
required

An empty string indicates no email.

is_disabled
boolean
required
read-only
has_portal_access
boolean
required
read-only
customer_id
integer | null
required
read-only
permissions
object[] | null
required
read-only
alignments
object[]
required
read-only

The teams the rep belongs to.

has_commission_overrides
boolean
required
read-only
identifier
string
notifications
object[]