API Reference

Prism

Objects

Engagements

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Patch object

PATCH/v2/prism/{teamId}/engagement/{engagementId}

Patch object

Path ParametersExpand Collapse

teamId: optional string

formatuuid

engagementId: string

formatuuid

Header ParametersExpand Collapse

"Idempotency-Key": optional string

minLength1

maxLength255

"If-Match": optional string

Body ParametersJSONExpand Collapse

default: optional map[unknown]

Properties keyed by property slug. Values can be strings, numbers, booleans, arrays, or null. For select/multiselect properties, values may be option slugs or option UUIDs on write; option slugs are returned on read.

list: optional unknown

ReturnsExpand Collapse

id: string

formatuuid

default: optional map[unknown]

Properties keyed by property slug.

list: optional unknown

Patch object

HTTP

HTTP

TypeScript

Python

Go

CLI Tool

curl https://developers.micro.so/v2/prism/$TEAM_ID/engagement/$ENGAGEMENT_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "x-api-key: $MICRO_API_KEY" \
    -d '{}'

200 example

200 example

200 example

200 example

200 example

{
  "id": "11111111-1111-4111-8111-111111111111",
  "default": {
    "full_name": "Sarah Chen",
    "email": "sarah@example.com",
    "title": "General Partner",
    "organization": "Acme Ventures"
  }
}

{
  "id": "22222222-2222-4222-8222-222222222222",
  "default": {
    "name": "Acme Ventures",
    "domain": "acme.example.com",
    "industry": "Venture Capital"
  }
}

{
  "id": "33333333-3333-4333-8333-333333333333",
  "default": {
    "name": "Acme Ventures — Series A",
    "amount": 2500000,
    "stage": "closed_won",
    "organization": "Acme Ventures"
  }
}

{
  "id": "44444444-4444-4444-8444-444444444444",
  "default": {
    "name": "Follow up with Sarah Chen",
    "status": "completed",
    "due_date": "2026-08-06",
    "contact": "Sarah Chen"
  }
}

{
  "id": "55555555-5555-4555-8555-555555555555",
  "default": {
    "name": "Acme Ventures — Series A notes",
    "content": "Sarah Chen confirmed the next diligence call.",
    "organization": "Acme Ventures"
  }
}

Returns Examples

200 example

200 example

200 example

200 example

200 example

{
  "id": "11111111-1111-4111-8111-111111111111",
  "default": {
    "full_name": "Sarah Chen",
    "email": "sarah@example.com",
    "title": "General Partner",
    "organization": "Acme Ventures"
  }
}

{
  "id": "22222222-2222-4222-8222-222222222222",
  "default": {
    "name": "Acme Ventures",
    "domain": "acme.example.com",
    "industry": "Venture Capital"
  }
}

{
  "id": "33333333-3333-4333-8333-333333333333",
  "default": {
    "name": "Acme Ventures — Series A",
    "amount": 2500000,
    "stage": "closed_won",
    "organization": "Acme Ventures"
  }
}

{
  "id": "44444444-4444-4444-8444-444444444444",
  "default": {
    "name": "Follow up with Sarah Chen",
    "status": "completed",
    "due_date": "2026-08-06",
    "contact": "Sarah Chen"
  }
}

{
  "id": "55555555-5555-4555-8555-555555555555",
  "default": {
    "name": "Acme Ventures — Series A notes",
    "content": "Sarah Chen confirmed the next diligence call.",
    "organization": "Acme Ventures"
  }
}