Skip to content
APIProductDomains and accessMember Directory

Member Directory routes: update

The Member Directory Verbs update as api.sb routes, with inputs, result, refusals and an example.

Reference for Member Directory, one group of Member Directory routes.

MemberDirectory.update

Changes the given properties of a Member Directory. Verb page.

Text
PATCH /{namespace}/member-directories/{id}

Path: id. Body, as JSON: the other inputs. Emits MemberDirectory.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Member Directory.
groupRolesjsonWhich directory group fills which Role in the Tenant.
lastChangeAtdatetimeWhen the Customer’s directory last pushed a change.

Returns

OutputTypeRequiredDescription
memberDirectoryMember DirectoryrequiredThe Member Directory.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X PATCH https://api.sb/leaseline.app/member-directories/directory_qZldlwGLVN \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"groupRoles":{}}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "memberDirectory": {
    "$id": "https://api.sb/leaseline.app/member-directories/directory_qZldlwGLVN",
    "$type": "MemberDirectory",
    "state": "draft",
    "groupRoles": {}
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "MemberDirectory.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}