Connections
Delete a Connection Field
Deletes a Connection field, removing the associated key-value data from a Connection. This method is useful for removing unused or sensitive data from a Connection.
delete/v2.0/connections/{connectionId}/fields/{fieldName}
Request
- Base URLhttps://api-trial.cognigy.ai/testing
- Auth
- API key in header X-API-Key
- or API key in query parameter api_key
- or API key in header x-cxone-authorization
- or OAuth 2Authorization code/auth/oauth2/authorizePasswordToken URL/auth/oauth2/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
connectionIdstring required
The Id of the Connection
fieldNamestring required
The name of the Connection field
Headers
Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'
The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.
Response
The Connection field was deleted successfully.
Changes
No recorded changes to this operation across all 1 revision of this API.