Skip to main content
POST
/
workspaces
/
{id}
/
invite
Invite Client
curl --request POST \
  --url https://api.kakiyo.com/v1/workspaces/{id}/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "roles": [
    "member"
  ],
  "redirectUrl": "https://portal.youragency.com"
}
'
{
  "membershipId": "membership_abc123",
  "userId": "user_xyz789",
  "email": "[email protected]",
  "portalUrl": "https://youragency.kakiyo.agency",
  "emailSent": true
}
Agency Plan Required - This endpoint is only available for teams on the Agency plan.

​
Endpoint

POST https://api.kakiyo.com/v1/workspaces/:workspaceId/invite

​
Path Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesThe workspace ID

​
Request Body

FieldTypeRequiredDescription
emailstringYesEmail address of the client to invite
rolesarrayNoRoles to assign (default: ["member"])
redirectUrlstringNoCustom redirect URL after authentication

​
Response

{
  "membershipId": "69724d91001234567890",
  "userId": "69724d91009876543210",
  "email": "[email protected]",
  "portalUrl": "https://youragency.kakiyo.agency",
  "emailSent": true
}

​
Example Request

curl -X POST "https://api.kakiyo.com/v1/workspaces/69724d900007cfde1d88/invite" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]"}'
An invitation email with a magic link is sent to the client. The email is sent from your custom domain if configured, otherwise from [email protected].

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Workspace ID

Body

application/json
​
email
string<email>
required

Email address of the client to invite

Example:

"[email protected]"

​
roles
string[]

Roles to assign to the client

Example:
["member"]
​
redirectUrl
string

Custom redirect URL after authentication

Example:

"https://portal.youragency.com"

Response

Client invited successfully

​
membershipId
string
Example:

"membership_abc123"

​
userId
string
Example:

"user_xyz789"

​
email
string
​
portalUrl
string
Example:

"https://youragency.kakiyo.agency"

​
emailSent
boolean
Example:

true