Skip to main content
POST
Register or update a provider template

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Body

application/json
name
string
required
Required string length: 1 - 255
external_template_ref
string
required
Required string length: 1 - 255
roles
object[]
Maximum array length: 50
active
boolean

Response

200 - application/json

Default Response

uuid
string
required
name
string
required
provider_key
string
required

The provider app's name (installations.app_id -> apps.name), stamped by the server — never sent in the request.

installation_uuid
string
required

The provider installation that owns this template (the credential's bound installation).

external_template_ref
string
required

The provider's template id on its side; unique per (installation, ref).

roles
object[]
required

Signer slots the provider declared: [{ name, kind }] with kind partner_contact, company_user or fixed.

active
boolean
required

The installation marks a template inactive when its roles change on the provider side.

created_at
string
required
updated_at
string
required