Skip to main content
PUT
Upsert an external actor

Authorizations

Authorization
string
header
required

An opaque Omnara personal or organization bearer token.

Path Parameters

orgID
string
required
Pattern: ^org_[a-z2-7]{26}$
projectID
string
required
Pattern: ^proj_[a-z2-7]{26}$

Body

application/json

Identity and attributes of an external actor. Actors are upserted by (provider_tenant_id, provider_user_id) with the external provider. Omitted attributes keep their stored values; provided attributes are overwritten, including empty values. omnara actors are implicit and integration providers own their own actor identities.

provider_user_id
string
required
Required string length: 1 - 128
provider_tenant_id
string
Required string length: 1 - 128
display_name
string
Maximum string length: 256
metadata
object

Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.

Response

The upserted actor.

id
string
required
Pattern: ^actr_[a-z2-7]{26}$
org_id
string
required
Pattern: ^org_[a-z2-7]{26}$
project_id
string
required
Pattern: ^proj_[a-z2-7]{26}$
provider
enum<string>
required

omnara for project members, an integration provider such as slack, or external for API-managed actors.

Available options:
omnara,
slack,
external
provider_user_id
string
required
metadata
object
required

Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.

created_at
string<date-time>
required
updated_at
string<date-time>
required
provider_tenant_id
string
display_name
string