Create a child schema

post https://{youraccountname}.api-us1.com/api/3/customObjects/schemas/{id}/child

🚧
No Body Required
No body is required for the POST since the parent schema ID is included in the URL.

Example RESPONSE:

{
  "schema": {
    "id": "475c4ea7-65cc-4d59-a690-6ac232633fca",
    "parentId": "230f6065-a8e5-4df2-a70a-f6832d004d8d",
    "slug": "app-cxapp-studio-app-id-event-tickets",
    "appId": "cxapp-studio-app-id",
    "visibility": "private",
    "labels": {"singular": "Event Ticket", "plural": "Event Tickets"},
    "description": "Event Tickets",
    "fields": [
        {
            "id": "name",
            "labels": {"singular": "Name", "plural": "Names"},
            "type": "textarea",
            "inherited": true
        }
    ],
    "relationships": [
      {
        "id": "primary-contact",
        "labels": {
          "singular": "Primary Contact",
          "plural": "Primary Contacts"
        },
        "description": "Primary contact that owns a ticket",
        "namespace": "contacts",
        "inherited": true
      }
    ],
    "icons": {
        "default": "https://d226aj4ao1t61q.cloudfront.net/n9mayqo2d_customobject.png"
    }
  }
}

Responses

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://youraccountname.api-us1.com/api/3/customObjects/schemas/id/child \
3
     --header 'accept: application/json'

Choose an example:

application/json

🚧No Body Required

Example RESPONSE:

200200

400400

🚧
No Body Required