POST /sites/{site_id}/users/invite

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

Servers

Path parameters

Name Type Required Description
site_id String Yes

Unique identifier for a Site

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
accessGroups[] Array No

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.

email String Yes

Email address of user to send invite to

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.