Skip to navigation
API Referenceworkspaces

Create Workspace

Create a workspace under your account. A workspace is a sending tenant with its own message history and its own sending-IP pool; every account starts with one called default, and you add more when you want separate histories — one per product, or one per environment. The returned id is what you pass as RRay-Workspace-Id.

Authentication

AuthorizationBearer

A workspace key (rray_live_…, bound to one workspace) or the account’s platform key. Platform keys name the target workspace with RRay-Workspace-Id. See Credentials.

Request

This endpoint expects an object.
namestringRequired1-100 characters

Name for the new workspace, unique within your account (1–100 characters).

Response

Successful Response
idstring

Identifier of the workspace. This is the value you send as RRay-Workspace-Id.

namestring
Name you gave the workspace.
statusstring
Whether the workspace may send.
egress_poolstring

Name of the sending-IP pool this workspace’s mail goes out through.

customer_idstring
Account that owns the workspace.
created_atdatetime

When the workspace was created (RFC 3339, UTC).

object"workspace"OptionalDefaults to workspace

Always workspace.

monthly_delivery_limitinteger or nullOptional

Ceiling on deliveries this workspace may send per billing period; null when it is only bounded by the account’s own allowance.

Errors

401
Unauthorized Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error