POST /api/3/customObjects/schemas
Create Schema
Servers
- https://{{yourAccountName}}.api-us1.com
- https://{{yourAccountName}}.activehosted.com
- https://trackcmp.net
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
api-token |
String | No |
Your ActiveCampaign API Token |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
schema |
Object | No | |
schema.description |
String | No | |
schema.labels |
Object | No | |
schema.labels.singular |
String | No | |
schema.labels.plural |
String | No | |
schema.slug |
String | No | |
schema.relationships[] |
Array | No | |
schema.relationships[].id |
String | No | |
schema.relationships[].namespace |
String | No | |
schema.relationships[].description |
String | No | |
schema.relationships[].labels |
Object | No | |
schema.relationships[].labels.singular |
String | No | |
schema.relationships[].labels.plural |
String | No | |
schema.relationships[].hasMany |
Boolean | No | |
schema.fields[] |
Array | No | |
schema.fields[].id |
String | No | |
schema.fields[].labels |
Object | No | |
schema.fields[].labels.singular |
String | No | |
schema.fields[].labels.plural |
String | No | |
schema.fields[].slug |
String | No | |
schema.fields[].isRequired |
Boolean | No | |
schema.fields[].type |
String | No | |
schema.fields[].scale |
Number | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.