Sales Engine
API documentation
SettingsOperation settings.memberRole

Change a member's role

Change a person's role (admin, manager, team or freelancer) and their own section switches. Only the owner changes an admin, a manager changes freelancers and team members; nobody changes their own access.

PATCH/api/v1/settings/members/{userId}
Scope write: Create and edit lists, research, sequences, campaigns, memory, signals and learning; queue jobs.

Parameters

Path

NameInDescription
userIdrequiredpathThe member's user id.

Body

A JSON object. Fields not listed are ignored.

NameInDescription
rolebodyadmin, manager, team or freelancer.
sectionsbody, objectSection switches for this person, { leads: true, campaigns: false }; a section left out follows the role.

Example

curl
curl -X PATCH "https://crm.ashwanth.dev/api/v1/settings/members/{userId}" \
  -H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "role": "",
  "sections": {}
}'
CLI
sales-engine settings member-role <userId>

The JSON above lists every documented field with a typed placeholder; send only the ones you mean.

Response

A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.

Shape
{
  "data": { ... }
}

Run it below to see the live shape for your workspace.

Try it

Runs against this server, as the workspace behind the key.
Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.
Path
required
The member's user id.
Every documented field is listed above; leave out the ones you do not need.
Request
PATCH /api/v1/settings/members/%7BuserId%7D
Fill the path first.

Also in Settings