Endpoint URL: {identityDomain} /config/{appId} /flows/{flow} /fields/{field}
Description
Removes a field from the flow. Also removes the field from any forms that were using it.
Respects the API Client Allow List: No
API Client Permissions
The following table indicates the API clients that can (and the API clients that can't) be used to call this endpoint:
owner | access_issuer | direct_access | direct_read_access | login_client |
Yes | No | Yes | No | No |
Authentication
This endpoint supports Basic authentication.
How to Create an Authentication String
Base URL
The base URL for this endpoint is your Configuration API domain followed by /config/ followed by your application ID. For example, if you are in the US region and your application ID is htb8fuhxnf8e38jrzub3c7pfrr, then your base URL would be:
https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr
Allowed regions are:
- us
- eu
- au
- sa
- cn
Query Parameters
Parameter | Type | Required | Description |
---|---|---|---|
force | string | Forces the deletion of a field even if it's still being used in forms. Forms in question will have the field removed. Allowed values are:
|
Sample Request (curl)
This command deletes the userFullName field from the documentation flow.
curl -X DELETE \ https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/fields/userFullName \ -H 'Authorization: Basic
c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg='
Responses
204 No Content
Successfully deleted the Field.
404 Not Found
Field could not be found. Please check the value and try again.
Response Example (application/json)
{
"errors": "Field not found."
}