> For the complete documentation index, see [llms.txt](https://docs.sprinthub.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sprinthub.com/en/topics/api/api-how-to-create-a-custom-object.md).

# API - How to Create a Custom Object

### Route

<mark style="color:green;">`POST`</mark> `/customobjects/objects/:id_definition?apitoken=your-token&i=your-instance`

### Query Params

<table><thead><tr><th width="291">Key</th><th width="450">Description</th></tr></thead><tbody><tr><td>i</td><td>Identifier of your instance, subdomain.</td></tr><tr><td>apitoken</td><td>API token.</td></tr></tbody></table>

### Path Params

| Key             | Description                                                                                                                                           |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| :id\_definition | ID of the Custom Object definition. You can check the list of available IDs [here](/en/topics/api/api-how-to-relate-a-custom-object-to-a-contact.md). |

## Testing Custom Object Creation

The request was sent using the software *Postman*. Should be inserted in the *body* the fields to be filled for the Custom Objects, the key must match the alias of each field. The expected response is an object representing the created Object.

{% hint style="info" %}
To link the created Object to a lead, use the ID returned in this call in the Custom Object relationship request.
{% endhint %}

<div data-with-frame="true"><figure><img src="/files/967ecf8c9141a36ca2b23778ae5d6e26a8ae8727" alt=""><figcaption><p><em>Request to Create Custom Object.</em></p></figcaption></figure></div>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.sprinthub.com/en/topics/api/api-how-to-create-a-custom-object.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.