---
title: "Invite team member REST API | HitKeep"
description: "Reference for the HitKeep REST API operation Invite team member, including request parameters, responses, and authentication notes."
canonical: "https://hitkeep.com/api/operations/apiuserteamsidmembers/post/"
---

# Invite team member REST API

POST

/api/user/teams/{id}/members

FetchcURL

```
const url = 'http://127.0.0.1:25737/api/user/teams/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/members';
const options = {
  method: 'POST',
  headers: {cookie: 'hk_token=<hk_token>', 'Content-Type': 'application/json'},
  body: '{"email":"hello@example.com","role":"owner"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```
curl --request POST \
  --url http://127.0.0.1:25737/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.

## Authorizations

- **[cookieAuth](https://hitkeep.com/api/#cookieauth)**

## Parameters

### Path Parameters

**id**

required

string format: uuid

## Request Bodyrequired

application/json

object

**email**

required

string format: email

**role**

required

string

Allowed values: owner admin member

## Responses

### 200

Invite or update response

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

##### Examplegenerated

```
{
  "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"
}
```

### 403

Access denied

application/json

object

**message**

string

##### Examplegenerated

```
{
  "message": "example"
}
```

### 409

Invite already pending

application/json

object

**message**

string

##### Examplegenerated

```
{
  "message": "example"
}
```

[Previous List team members](https://hitkeep.com/api/operations/apiuserteamsidmembers/get/)[Next Remove team member](https://hitkeep.com/api/operations/apiuserteamsidmembersuserid/)