a13nDocs
API referenceProviders

Update web provider

A `config` change must also replace or remove a stored credential: it never follows a new endpoint.

PATCH/api/v1/web-providers/{provider_id}

A config change must also replace or remove a stored credential: it never follows a new endpoint.

Authorization

AuthorizationBearer <token>

A workspace API key (a13n_...)

In: header

Path Parameters

provider_id*Provider Id

Header Parameters

If-Match?|

The resource's ETag: "{id}:{version}" of its current view, "{key}:{version}" for a model

X-Workspace-ID?|

The workspace ID a login session acts in; required with a login session. An API key acts in its own workspace and needs none; naming another is forbidden.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/web-providers/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "config": {    "property1": null,    "property2": null  },  "created_at": "2019-08-24T14:15:22Z",  "created_by_id": "string",  "credential_configured": true,  "enabled": true,  "header_names": [    "string"  ],  "id": "string",  "name": "string",  "organization_id": "string",  "type": "string",  "updated_at": "2019-08-24T14:15:22Z",  "updated_by_id": "string",  "version": 0,  "workspace_id": "string"}