Invite User

POST

Invite a user by email address

Path parameters

site_idstringRequired

Unique identifier for a Site

Headers

Accept-VersionstringOptional

The API version

Request

This endpoint expects an object.

emailstringRequired

Email address of user to send invite to

accessGroupslist of stringsOptional

An array of access group slugs. Access groups are assigned to the user as type admin and the user remains in the group until removed.

Response

Request was successful

_idstringOptional

Unique identifier for the User

createdOndatetimeOptional

The timestamp the user was created

updatedOndatetimeOptional

The timestamp the user was updated

invitedOndatetimeOptional

The timestamp the user was invited

lastLogindatetimeOptional

The timestamp the user was logged in

emailVerifiedbooleanOptional

Shows whether the user has verified their email address

statusenumOptional

Allowed values: invitedverifiedunverified

The status of the user

accessGroupslist of objectsOptional

Access groups the user belongs to

datamap from strings to anyOptional

An object containing the User’s basic info and custom fields

POST

1 curl -X POST https://api.webflow.com/sites/580e63e98c9a982ac9b8b741/users/invite \
2      -H "Accept-Version: 1.0.0" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '{
6   "email": "some.one@home.com",
7   "accessGroups": [
8     "webflowers"
9   ]
10 }'

200Successful

1 {
2   "_id": "6287ec36a841b25637c663df",
3   "createdOn": "2022-05-20T13:46:12Z",
4   "updatedOn": "2022-05-20T13:46:12Z",
5   "invitedOn": "2016-10-24T19:41:29Z",
6   "lastLogin": "2016-10-24T19:41:29Z",
7   "emailVerified": true,
8   "status": "verified",
9   "accessGroups": [
10     {
11       "slug": "webflowers",
12       "type": "admin"
13     },
14     {
15       "slug": "platinum",
16       "type": "ecommerce"
17     }
18   ],
19   "data": {
20     "accept-privacy": false,
21     "accept-communications": false,
22     "email": "Some.One@home.com",
23     "name": "Some One"
24   }
25 }

Account Added

Up Next

Built with

1	curl -X POST https://api.webflow.com/sites/580e63e98c9a982ac9b8b741/users/invite \
2	-H "Accept-Version: 1.0.0" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"email": "some.one@home.com",
7	"accessGroups": [
8	"webflowers"
9	]
10	}'

1	{
2	"_id": "6287ec36a841b25637c663df",
3	"createdOn": "2022-05-20T13:46:12Z",
4	"updatedOn": "2022-05-20T13:46:12Z",
5	"invitedOn": "2016-10-24T19:41:29Z",
6	"lastLogin": "2016-10-24T19:41:29Z",
7	"emailVerified": true,
8	"status": "verified",
9	"accessGroups": [
10	{
11	"slug": "webflowers",
12	"type": "admin"
13	},
14	{
15	"slug": "platinum",
16	"type": "ecommerce"
17	}
18	],
19	"data": {
20	"accept-privacy": false,
21	"accept-communications": false,
22	"email": "Some.One@home.com",
23	"name": "Some One"
24	}
25	}