invite_codes
Creates, updates, deletes, gets or lists an invite_codes resource.
Overview​
| Name | invite_codes |
| Type | Resource |
| Id | railway.projects.invite_codes |
Fields​
The following fields are returned by SELECT queries:
- get
One InviteCode row.
| Name | Datatype | Description |
|---|---|---|
id | string | |
project_id | string | |
code | string | |
created_at | string (date-time) | |
project | object | Project object |
role | string | (ADMIN, MEMBER, VIEWER) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | code | Get an invite code by the code. Backed by the Railway GraphQL query inviteCode. | |
use | exec | code | Join a project using an invite code. Backed by the Railway GraphQL mutation inviteCodeUse. |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
code | string |
SELECT examples​
- get
Get an invite code by the code. Backed by the Railway GraphQL query inviteCode.
SELECT
id,
project_id,
code,
created_at,
project,
role
FROM railway.projects.invite_codes
WHERE code = '{{ code }}' -- required
;
Lifecycle Methods​
- use
Join a project using an invite code. Backed by the Railway GraphQL mutation inviteCodeUse.
EXEC railway.projects.invite_codes.use
@code='{{ code }}' --required
;