Skip to main content
Users

Invite people to manage a site

Sends an invitation to each email address in invite. The response lists the addresses that were invited and the ones that failed.

POST
/users/invite/{siteUuidOrDomain}

Authorizations

Authorizationstringheaderrequired

A reseller API token, issued by Consent Studio support.

Path Parameters

siteUuidOrDomainstringrequired

The UUID or the domain of one of your sites.

Body

application/json
can_manage_billingbooleandefault:true

Whether the people you invite may manage billing for this site.

can_manage_membersbooleandefault:true

Whether the people you invite may invite and remove other members of this site.

invitestring | string[]required

The email address to invite, or a list of them.

receive_recommendation_emailsbooleandefault:true

Whether the people you invite receive recommendation emails for this site.

Response

application/json

Successful response.

failedstringrequired
messagestringrequired
successfulstringrequired

Still need help? Ask the team