Skip to content

by Startups.Studio

Product Domains and access Member Directory

MemberDirectory.update

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

Changes the given properties of a Member Directory.

Noun: Member Directory
Mode: do
Event: MemberDirectory.updated

You, to your agent

Change the latest member directory.

curl -X PATCH https://api.sb/petpantry.shop/member-directories/member_directory_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"groupRoles":{}}'

import { $ } from 'startup-builder'

const memberDirectory = await $.MemberDirectory.update({ id: 'member_directory_1', groupRoles: {} })

npx startup-builder do MemberDirectory.update --json '{"id":"member_directory_1","groupRoles":{}}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.MemberDirectory.update({ id: 'member_directory_1', groupRoles: {} })"
  }
}

Update changes the given properties of a Member Directory. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Member Directory.
`groupRoles`	`json`		Which directory group fills which Role in the Tenant.
`lastChangeAt`	`datetime`		When the Customer’s directory last pushed a change.

Outputs

Output	Type	Required	Description
`memberDirectory`	Member Directory	required	The Member Directory.

Effects

Emits MemberDirectory.updated.
Two-way: try, send, do.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	MemberDirectory.update

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

MemberDirectory.provision

Previous Page

SSO Connection

Next Page