Delete Custom Object Type¶

POST /rest/v1/customobjects/schema/{apiName}/delete.json

Permissions Read-Write Custom Object Type

Method: POST
Path: /rest/v1/customobjects/schema/{apiName}/delete.json
Tag: Custom Objects
Operation ID: deleteCustomObjectTypeUsingPOST

Deletes the target custom object type. The type must first be removed from use by any assets, such as triggers or filters. Required Permissions: Read-Write Custom Object Type

Formats¶

Request: application/json
Response: application/json

Request¶

Path parameters¶

Name	Type	Required	Description	Constraints
`apiName`	string	Yes	API Name of the custom object type to delete

Example request¶

POST {{base_url}}/rest/v1/customobjects/schema/{{apiName}}/delete.json
Accept: application/json

Responses¶

200 — OK¶

Schema: model: ResponseOfCustomObjectType

Generated example¶

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "requestId": "123",
  "result": [
    "string"
  ],
  "success": false,
  "warnings": [
    {
      "code": 123,
      "message": "string"
    }
  ]
}

Referenced models¶

ResponseOfCustomObjectType

Source¶

Generated from swagger-mapi.json.

Generated examples are inferred from the schema. They are illustrative and may not be valid production payloads.