Skip to content
Start in Cloud

Invite team member

POST
/api/user/teams/{id}/members
curl --request POST \
--url https://hitkeep.com/api/user/teams/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/members \
--header 'Content-Type: application/json' \
--cookie hk_token=<hk_token> \
--data '{ "email": "hello@example.com", "role": "owner" }'

Creates a pending invite for a user or updates the role of an existing member.

id
required
string format: uuid
Media type application/json
object
email
required
string format: email
role
required
string
Allowed values: owner admin member

Invite or update response

Media type application/json
object
invite
object
accepted_at
string format: date-time
created_at
string format: date-time
created_by
string format: uuid
email
string format: email
expires_at
string format: date-time
id
string format: uuid
invited_user_id
string format: uuid
revoked_at
string format: date-time
role
string
status
string
team_id
string format: uuid
is_invite
boolean
status
string
Example generated
{
"invite": {
"accepted_at": "2026-04-15T12:00:00Z",
"created_at": "2026-04-15T12:00:00Z",
"created_by": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"email": "hello@example.com",
"expires_at": "2026-04-15T12:00:00Z",
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"invited_user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"revoked_at": "2026-04-15T12:00:00Z",
"role": "example",
"status": "example",
"team_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
},
"is_invite": true,
"status": "example"
}

Access denied

Media type application/json
object
message
string
Example generated
{
"message": "example"
}

Invite already pending

Media type application/json
object
message
string
Example generated
{
"message": "example"
}