/membersAdd Member
Invites a new user or grants an existing org member a role on the project.
The request body accepts userId or email plus a role.
If the user is already an org member the operation is a direct role grant; if not, an invitation token is issued.
Requires PROJECT_ADMIN or ORG_ADMIN.
| projectSlug * | path | The project's slug: the path segment after It is unique within the org. |
| One of: object | ||
| userId * | string | The user to add ( The user must already be an accepted member of the project's organization. |
| role * | "PROJECT_ADMIN" | "PROJECT_EDITOR" | "PROJECT_MEMBER" | "PROJECT_VIEWER" | "PROJECT_AUDITOR" | "PROJECT_AUTHOR" | "PROJECT_ANALYST" | The project role to give: |
| idempotencyKey | string | A key that makes the request safe to retry: a repeat of a successful grant with the same key and body returns the same response instead of acting again. Generated when omitted. |
| or: object | ||
| email * | string <email> | The email address of the user to add. The user must already be an accepted member of the project's organization. |
| role * | "PROJECT_ADMIN" | "PROJECT_EDITOR" | "PROJECT_MEMBER" | "PROJECT_VIEWER" | "PROJECT_AUDITOR" | "PROJECT_AUTHOR" | "PROJECT_ANALYST" | The project role to give: |
| idempotencyKey | string | A key that makes the request safe to retry: a repeat of a successful grant with the same key and body returns the same response instead of acting again. Generated when omitted. |
| HTTP | K9O Code | Description |
|---|---|---|
| 201 | Created | |
| 401 | K9O_SESSION_EXPIRED | Your session has expired; sign in again to continue. |
| 403 | K9O_ACCESS_DENIED | You do not have the required role (PROJECT_ADMIN or higher) to add members to this project. |
| 410 | K9O_SLUG_GONE | The project slug in the URL has been renamed; update your integration to use the new slug. |
| data * | object | A project member. |
| userId * | string | The member's user id ( |
| projectId * | string | The project's id ( |
| role * | "PROJECT_ADMIN" | "PROJECT_EDITOR" | "PROJECT_MEMBER" | "PROJECT_VIEWER" | "PROJECT_AUDITOR" | "PROJECT_AUTHOR" | "PROJECT_ANALYST" | The member's explicit project role. Org owners and admins also have admin access to every project without a row here, and are listed only if they have one. |
| email * | string | The member's sign-in email address. |
| displayName * | string | The member's display name. |
| invitedAt * | string <date-time> | When the membership was created. |
| acceptedAt * | any | When the membership was accepted, or null while it is still an invitation. |
| One of: string <date-time> | ||
| or: null | ||
| state * | "invited" | "active" |
|
| meta * | any | Request metadata: cost, timing and the request and trace ids. |
curl -X POST 'https://<org>.api-<region>.k9o.io/@storefront/members' \
-H 'Authorization: Bearer $K9O_TOKEN' \
-H 'Content-Type: application/json' \
-d '{}'Showing example in cURL
{
"userId": "string",
"role": "PROJECT_ADMIN",
"idempotencyKey": "string"
}{
"data": {
"userId": "string",
"projectId": "string",
"role": "PROJECT_ADMIN",
"email": "string",
"displayName": "string",
"invitedAt": "string",
"acceptedAt": "string",
"state": "invited"
}
}