Skip to main content

Create staff

POST 
/partner/v1/staff/

Creates a staff profile for the authenticated company. Provide a name and at least one non-null email or phone. Phone is the primary worker identifier when both are supplied. If the phone matches an existing worker profile, that profile is reused even when the email identifies a different profile. Otherwise, email is matched case-insensitively. Reusing a claimed worker profile does not overwrite its worker-controlled name or contact information.

Create requests are not idempotent. A staff profile in the authenticated company is considered a duplicate only when it matches every supplied contact identifier. An exact retry after creating a new profile therefore returns 409 staff_already_exists with the existing resource URL in the Location header rather than repeating the original 201 response.

An invitation is not sent by default. Set send_invitation to true to request an email invitation; it is sent only when the profile has an email address and the worker has not activated their account.

Before a company's first account trial or subscription purchase, profile creation is capped at the account's staff capacity, including inactive and removed profiles. Additional profiles return 403 with code account_staff_profile_limit_reached.

Request​

Responses​

The staff profile.

Response Headers
    Location

    URL of the created or existing staff resource.

    Example: /partner/v1/staff/123/