Skip to main content
PATCH
Update Entity

Authorizations

Authorization
string
header
required

Opaque API key passed as Authorization: Bearer <key>. Keys are organization-bound, environment-bound (live or test), scope-carrying, and expiring. Create and manage keys via the console.

Path Parameters

entityId
string<uuid>
required

Body

application/json
contactEmails
string<email>[]
required

Replacement list of email addresses for the people who manage this entity's connections. The supplied list replaces the existing one. Duplicates are removed (case-insensitively) and order is preserved; send an empty array to clear all contacts. At most 100 addresses.

Maximum array length: 100

Response

Successful Response

entityId
string
required

Stable, immutable identifier for the entity.

externalEntityId
string
required

Stable external identifier for this entity. Integrator-defined for customer entities and system-defined for the organization-attached entity.

isDefaultOrgEntity
boolean
required

Whether this special entity is the organization-attached entity managed by Waycore. Use it when the integrator and the end business are the same organization.

createdAt
string<date-time>
required

When the entity was created in this API.

updatedAt
string<date-time>
required

When the entity last changed in this API.

name
string | null

Display name for the entity, when available.

contactEmails
string<email>[]

Email addresses of the people who manage this entity's connections. Used to reach the right person when a connection's configuration is invalid or needs attention. Always present; an empty array means no contacts have been provided.

metadata
Metadata · object | null

Opaque client-defined metadata.