Delete an object
DELETE/objects/:object_id
Soft-delete a custom object. Scope objects_admin. The body must repeat the
object's label as confirm_name, exactly as the console asks a person to type it.
The object disappears from menus at once and can be restored from the console during the grace period; its records are purged after it. Relation fields in other objects that pointed at it are removed immediately. Built-in objects and the Customers / Contacts objects cannot be deleted.
Request
Responses
- 200
- 400
- 401
- 403
- 404
Object deleted.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
The request was malformed, or a parameter was rejected.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
No token, an expired token, or a credential that has been revoked.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
Refused. Either the credential does not hold the scope this endpoint needs (code: insufficient_scope), or the account's IP allow-list does not include the calling address (code: ip_not_allowed).
Response Headers
Correlation id for this request. Quote it when reporting a problem.
No such resource in this account.
Response Headers
Correlation id for this request. Quote it when reporting a problem.