Error

A valid request URL is required to generate request examples

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

People

Send an admin email to a person

Triggers an admin email action for the specified person. The emailType determines the action:

RESEND_ACTIVATION — Resends the activation email to a person with INVITED status who has a platform account.
RESEND_OFFBOARDING — Resends the arrange-return / offboarding email to a person who is currently being offboarded (OFFBOARDING status).
SEND_PLATFORM_INVITE — Sends a platform access invite email to an ACTIVE person who does not yet have platform access. Creates a platform account and sets the person’s status to INVITED.

POST

api

people

{personId}

emails

Error

A valid request URL is required to generate request examples

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

Authorizations

Authorization

string

header

required

Prefix the value with "ApiKey" to indicate the custom authorization type

Path Parameters

personId

string<uuid>

required

Body

application/json

Request body for triggering an admin email action to a person

emailType

enum<string>

required

The type of email action to trigger. RESEND_ACTIVATION: resend activation email to an INVITED person. RESEND_OFFBOARDING: resend the arrange-return email to a person in OFFBOARDING status. SEND_PLATFORM_INVITE: send a platform access invite to an ACTIVE person without a platform account.

Available options:

RESEND_ACTIVATION,

RESEND_OFFBOARDING,

SEND_PLATFORM_INVITE

Response

Email sent successfully

SCIM Bulk operations List shipment notice orders for the authenticated organization (V1)

⌘I

People

Shipment Notices V1

Returns

Replacements

People — Lifecycle

Packages

Orders

New Joiners

ITAD

Inventory

Inventory Orders

Inventory Levels

Assets

Return Orders

Offices

Warehouses V1

Shipment

Regions V1

Categories

Catalog

Brands

Send an admin email to a person

Authorizations

Path Parameters

Body

Response