Skip to navigation
API ReferenceUsers

Invite User

Invite a member to your company, the same as Invite Members in Coperniq: name, email, seat, role, phone and labor cost.

  • seatType is required. Field and Office seats must be on your plan with one free; the API does not buy seats.
  • roleIds is required unless seatType is READONLY. A Viewer seat only takes VIEW_AND_COMMENT roles (see roleType on GET /roles).
  • Inviting an email that already belongs to an active member changes nothing and returns status: "exists".
  • Use GET /users?email= to read the new member’s id, seatType and laborHourlyRate.

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
emailstringRequiredformat: "email"
Email address to send the invite to
firstNamestringRequired

Member’s first name (up to 300 characters)

lastNamestringRequired

Member’s last name (up to 300 characters)

seatTypeenumRequired

Seat to assign, the same as Seat in Coperniq’s Invite Members:

  • FIELD (Field) and OFFICE (Office) are paid seats. Your plan must include that seat type and have one free. The API does not buy seats; buy more in Coperniq first.
  • READONLY (Viewer) is free, with view and comment access.
Allowed values:
roleIdslist of integersOptional

Role IDs from GET /roles. Required unless seatType is READONLY.

A READONLY seat only takes roles with roleType: VIEW_AND_COMMENT. Leave roleIds out to use the default Viewer role.

phonestringOptional<=20 characters
Member's phone number
laborHourlyRatedoubleOptional>=0

Labor cost in dollars per hour (Labour cost, $/hr in Coperniq)

Response

Invite sent (success), or the email is already an active member (exists)

emailstringOptionalformat: "email"
statusenumOptional

success: invite sent. exists: already an active member, nothing changed.

Allowed values:

Errors

400
Bad Request Error