---
title: Respond to Invitation
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[User](https://developers.cloudflare.com/api/resources/user)
[Invites](https://developers.cloudflare.com/api/resources/user/subresources/invites)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Respond to Invitation
PATCH/user/invites/{invite\_id}
Responds to an invitation.
##### Security
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
**Example:**`X-Auth-Email: user@example.com`
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
**Example:**`X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194`
##### Accepted Permissions (at least one required)
`Memberships Write`
##### P ath ParametersExpand Collapse
invite\_id: string
Invite identifier tag.
maxLength32
[Link to this property](<#(resource)%20user.invites%20%3E%20(method)%20edit%20%3E%20(params)%20default%20%3E%20(param)%20invite_id%20%3E%20(schema)>)
##### Body ParametersJSONExpand Collapse
status: "accepted"or "rejected"
Status of your response to the invitation (rejected or accepted).
One of the following:
"accepted"
Link to this property
"rejected"
Link to this property
[Link to this property](<#(resource)%20user.invites%20%3E%20(method)%20edit%20%3E%20(params)%200%20%3E%20(param)%20status%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: array of object {code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20user.invites%20%3E%20(method)%20edit%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of object {code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20user.invites%20%3E%20(method)%20edit%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
success: true
Whether the API call was successful.
[Link to this property](<#(resource)%20user.invites%20%3E%20(method)%20edit%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
result: optional Invite { invited\_member\_id, organization\_id, id, 8 more }
invited\_member\_id: string
ID of the user to add to the organization.
maxLength32
Link to this property
organization\_id: string
ID of the organization the user will be added to.
maxLength32
Link to this property
id: optional string
Invite identifier tag.
maxLength32
Link to this property
expires\_on: optional string
When the invite is no longer active.
formatdate-time
Link to this property
invited\_by: optional string
The email address of the user who created the invite.
maxLength90
Link to this property
invited\_member\_email: optional string
Email address of the user to add to the organization.
maxLength90
Link to this property
invited\_on: optional string
When the invite was sent.
formatdate-time
Link to this property
organization\_is\_enforcing\_twofactor: optional boolean
Link to this property
organization\_name: optional string
Organization name.
maxLength100
Link to this property
roles: optional array of string
List of role names the membership has for this account.
Link to this property
status: optional "pending"or "accepted"or "rejected"or "expired"
Current status of the invitation.
One of the following:
"pending"
Link to this property
"accepted"
Link to this property
"rejected"
Link to this property
"expired"
Link to this property
Link to this property
[Link to this property](<#(resource)%20user.invites%20%3E%20(method)%20edit%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
### Respond to Invitation
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/user/invites/$INVITE_ID \
-X PATCH \
-H 'Content-Type: application/json' \
-H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
-H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
-d '{
"status": "accepted"
}'
```
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"success": true,
"result": {
"invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
"organization_id": "5a7805061c76ada191ed06f989cc3dac",
"id": "4f5f0c14a2a41d5063dd301b2f829f04",
"expires_on": "2014-01-01T05:20:00Z",
"invited_by": "user@example.com",
"invited_member_email": "user@example.com",
"invited_on": "2014-01-01T05:20:00Z",
"organization_is_enforcing_twofactor": true,
"organization_name": "Cloudflare, Inc.",
"roles": [
"Account Administrator"
],
"status": "accepted"
}
}
```
##### Returns Examples
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"success": true,
"result": {
"invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
"organization_id": "5a7805061c76ada191ed06f989cc3dac",
"id": "4f5f0c14a2a41d5063dd301b2f829f04",
"expires_on": "2014-01-01T05:20:00Z",
"invited_by": "user@example.com",
"invited_member_email": "user@example.com",
"invited_on": "2014-01-01T05:20:00Z",
"organization_is_enforcing_twofactor": true,
"organization_name": "Cloudflare, Inc.",
"roles": [
"Account Administrator"
],
"status": "accepted"
}
}
```