solarOS Organization API

Organization API

Update an API-authored Activity

Only the API key that created an Activity can update it, including repairing the stored Team Member author. Required scope: activities:write.

/api/v1/activities/{id}

Only the API key that created an Activity can update it, including repairing the stored Team Member author. Required scope: activities:write.

Update an API-authored Activity. Use an organization API key with activities:write. Check the response envelope and meta.requestId before triggering dependent workflow steps.

Required scopes

activities:write

Parameters

NameInTypeDescription
idrequiredpathstringActivity identifier returned by the Organization API.

Request body

objectrequired
FieldTypeDescription
typeNOTE | CALL | EMAIL | MEETING | SMS | TASKOptional unless marked required.
contentstringOptional unless marked required.
authorIdstringOptional unless marked required.
visibilityINTERNAL | TEAM | CUSTOMEROptional unless marked required.
isPinnedbooleanOptional unless marked required.
metadataobjectOptional unless marked required.
updateactivityRequest
{
  "content": "Customer requested a battery backup option.",
  "isPinned": true
}

Responses

200

Updated Activity envelope

#/components/schemas/OrgApiResourceEnvelope

401

Missing or invalid organization API key

#/components/schemas/OrgApiError

402

Organization billing access or an endpoint-specific business quota denied the request

#/components/schemas/OrgApiError

403

Different author

#/components/schemas/OrgApiError

429

Rate limit exceeded

#/components/schemas/OrgApiError

Errors

401 Missing or invalid organization API key402 Organization billing access or an endpoint-specific business quota denied the request403 Different author429 Rate limit exceeded

Static examples

curl -X PATCH "$SOLAROS_BASE_URL/api/v1/activities/$SOLAROS_ACTIVITY" \
  -H "Authorization: Bearer $SOLAROS_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{"content":"Customer requested a battery backup option.","isPinned":true}'