Skip to main content
POST
Assign settings

Authorizations

Authorization
string
header
required

Your API key, sent bare. See Authentication.

Body

application/json
settings_id
string
required

The settings to apply, beginning with set_.

scope
string[]
required

The conditions that must all hold.

One condition of an assignment's scope, written <kind>:<name>. Every condition of a scope must hold.

  • workspace:wks_…: the workspace's members and meetings. A scope names exactly one workspace: or member:.
  • member:mem_…: one member's meetings.
  • meeting:mtg_…: one meeting, this occurrence only. It implies its workspace; a scope with it names no member.
  • meetings:organized: meetings the member organizes.
  • meetings:internal: meetings where every participant is a workspace member.
  • meetings:domain: meetings where every participant is on the member's email domain.
  • meetings:external: meetings with at least one participant outside the workspace.

One category per scope for now; to record external or organized meetings, make two assignments of the same settings.

Response

The assignment.

id
string

Beginning with asg_.

object
string

Always settings_assignment.

settings_id
string

The settings it applies, beginning with set_.

scope
string[]

The conditions that must all hold.

One condition of an assignment's scope, written <kind>:<name>. Every condition of a scope must hold.

  • workspace:wks_…: the workspace's members and meetings. A scope names exactly one workspace: or member:.
  • member:mem_…: one member's meetings.
  • meeting:mtg_…: one meeting, this occurrence only. It implies its workspace; a scope with it names no member.
  • meetings:organized: meetings the member organizes.
  • meetings:internal: meetings where every participant is a workspace member.
  • meetings:domain: meetings where every participant is on the member's email domain.
  • meetings:external: meetings with at least one participant outside the workspace.

One category per scope for now; to record external or organized meetings, make two assignments of the same settings.

created_at
string<date-time>

When the assignment was made, in ISO 8601.