delete_a_field_1
Delete a field from a custom object schema. This action is irreversible and removes associated field data immediately.
Instructions
🔴 DESTRUCTIVE · deletes data · Custom Objects · DELETE /customObjects/schemas/{schemaId}/fields/{fieldId}
Delete a field
Deletes a record. Confirm with the user before calling.
Deleting a schema field is an irreversible process.
Assuming a valid 202 Accepted response is received, any associated field data on associated records will immediately be unavailable to the user. There may be a small delay if record requests are in the midst of processing when the field delete request is issued.
The deleted field id will not be immediately recycled for reuse. Users are encouraged to leverage the ?showFields=all query parameter when programmatically creating new schema f…
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fieldId | Yes | Field ID of the field to be deleted | |
| schemaId | Yes | Schema ID of the field to be deleted | |
| showFields | No | Toggle which fields are shown in the response body of a schema (if there hidden due to e.g. recently being deleted). Omit this parameter entirely to hide fields by default. | all |