Create workspace participant

POST/v1/invitations

Body parameters

application/json · required

email string required

Email address associated with the identity.

Maximum length: 2048 characters.

Exampleowner@example.com

role string required

Role assigned to the identity in the workspace.

Allowed values: "owner", "admin", "member"

Exampleowner

Headers

authorization string required

Bearer workspace API key.

ExampleBearer $NQD_API_KEY

workspace-id string required

Workspace scope for the request. Required for workspace operations and must belong to the authenticated identity.

Minimum length: 1 character. · Maximum length: 128 characters.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1A

Response

200Success

Response headers

x-request-id string

Correlation identifier returned with every response for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000

data object

Returned records. Collections and batches use an array; single records use an object.

One of: object alternative 1, object alternative 2

ShowHide 2 properties

data.member object

member for this invitation. Applies to object alternative 1.

ShowHide 4 properties

data.member.profileId string

ID of the related profile.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1B

data.member.username string

username within member.

Exampleowner

data.member.email string

Email address associated with the identity.

Exampleowner@example.com

data.member.role string

Role assigned to the identity in the workspace.

Allowed values: "owner", "admin", "member"

Exampleowner

data.invite object

invite for this invitation. Applies to object alternative 2.

ShowHide 5 properties

data.invite.id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P2C

data.invite.email string

Email address associated with the identity.

Exampleowner@example.com

data.invite.role string

Role assigned to the identity in the workspace.

Allowed values: "owner", "admin", "member"

Exampleowner

data.invite.invitedAt string

ISO 8601 timestamp for invited.

Example2026-01-15T12:00:00.000Z

data.invite.expiresAt string

ISO 8601 timestamp when the invitation expires.

Example2026-01-15T12:00:00.000Z

Possible errors

400 Invalid request

Response headers

x-request-id string

Correlation identifier returned with every response for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000

error object

Error details returned for a failed request.

ShowHide 4 properties

error.code string

Stable machine-readable error or resource code.

Exampleinvalid_input

error.message string

Human-readable explanation of the result or error.

ExampleThe request could not be validated.

error.requestId string

Correlation identifier for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000

error.details object nullable

Additional structured details about the result or error.

ShowHide 1 property

error.details.issues object[]

Structured field issues returned when request validation fails.

ShowHide 3 properties

error.details.issues[].path string | number[]

Field path where the validation issue occurred.

One of: string alternative 1, number alternative 2

Example0 items

error.details.issues[].reason string

Machine-readable reason for the validation issue.

Allowed values: "expected_type", "required", "unexpected_property", "invalid_value", "invalid_json", "invalid_query", "unsupported_media_type", "body_too_large", "body_timeout", "conflicting_scope", "missing_header", "concurrency_required", "invalid_resource_id", "invalid_request"

Exampleinvalid_request

error.details.issues[].code string nullable

Stable machine-readable error or resource code.

Exampleinvalid_input

{
  "error": {
    "code": "invalid_input",
    "message": "The request could not be validated.",
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "details": {
      "issues": [
        {
          "path": [],
          "reason": "invalid_request"
        }
      ]
    }
  }
}

View raw OpenAPI operation

Use the machine-readable contract for client generation and payload validation.

Open OpenAPI contract ↗