Create and Invite a User — Webflow API Documentation

Create and invite a user with an email address.

The user will be sent and invite via email, which they will need to accept in order to join paid any paid access group.

Required scope | users:write

Path parameters

site_idstringRequired

Unique identifier for a Site

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

isEmailVerifiedbooleanOptionalDefaults to false

Shows whether the user has verified their email address

lastUpdateddatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The timestamp the user was updated

invitedOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The timestamp the user was invited

createdOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The timestamp the user was created

lastLogindatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The timestamp the user was logged in

statusenumOptional

Allowed values: invitedverifiedunverified

The status of the user

accessGroupslist of objectsOptional

Access groups the user belongs to

dataobjectOptional

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

Errors

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

1 { 2 "id": "6287ec36a841b25637c663df", 3 "isEmailVerified": true, 4 "lastUpdated": "2022-05-20T13:46:12Z", 5 "invitedOn": "2022-05-20T13:46:12Z", 6 "createdOn": "2022-05-20T13:46:12Z", 7 "lastLogin": "2022-05-20T13:46:12Z", 8 "status": "verified", 9 "accessGroups": [ 10 { 11 "slug": "webflowers", 12 "type": "admin" 13 } 14 ], 15 "data": { 16 "data": { 17 "name": "name", 18 "email": "email", 19 "accept-privacy": true, 20 "accept-communications": true, 21 "additionalProperties": "additionalProperties" 22 } 23 } 24 }

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

1	{
2	"id": "6287ec36a841b25637c663df",
3	"isEmailVerified": true,
4	"lastUpdated": "2022-05-20T13:46:12Z",
5	"invitedOn": "2022-05-20T13:46:12Z",
6	"createdOn": "2022-05-20T13:46:12Z",
7	"lastLogin": "2022-05-20T13:46:12Z",
8	"status": "verified",
9	"accessGroups": [
10	{
11	"slug": "webflowers",
12	"type": "admin"
13	}
14	],
15	"data": {
16	"data": {
17	"name": "name",
18	"email": "email",
19	"accept-privacy": true,
20	"accept-communications": true,
21	"additionalProperties": "additionalProperties"
22	}
23	}
24	}