VocalDocscontracts 1.65.0

Replace the Provider registry

PATCH /v1/platform/providers

PropertyValue
Operationupdate_platform_providers
GroupPlatform
Scopeplatform:write
Route classcontrol
IdempotencyNo Idempotency-Key
AuditAudited platform.providers.update (mutation)
Released in1.10.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the platform:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X PATCH "$VOCAL_API/v1/platform/providers" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H 'If-Match: "1"' \
  -H "Content-Type: application/json" \
  -d '{
    "entries": [],
    "secondaries": {}
  }'

Parameters

NameInTypeRequiredDescription
if-matchheaderstringyesThe revision the change was made against, quoted as the ETag returns it, or * to overwrite.

Request body

Content type application/json, required: ProviderRegistryUpdateRequest.

FieldTypeRequiredDescription
entriesarray of ProviderRegistryEntryInputyes
secondariesStageSecondariesInputyes

Responses

StatusContent typeShapeError codes
200application/jsonProviderRegistry
400application/jsonErrorEnvelopeinvalid_request
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
412application/jsonErrorEnveloperevision_mismatch
422application/jsonErrorEnvelopevalidation_failed
428application/jsonErrorEnvelopeprecondition_required
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is ProviderRegistry.

FieldTypeRequiredDescription
entriesarray of ProviderRegistryEntryyes
object"platform_providers"yes
secondariesStageSecondariesyes
updated_atTimestamp or nullyes
updated_byActorRef or nullyes
versionintegeryes0 before the first replacement; the ETag.