Create an app

POST

Creates an app

Headers

X-Disable-Hooks"true"RequiredDefaults to true

Request

This endpoint expects an object.

namestringRequired

namespacestringRequired

typeenumRequired

Allowed values: PORTALPROJECTSMAPPINGWORKBOOKSCUSTOM

entitystringOptional

entityPluralstringOptional

iconstringOptional

metadataanyOptional

environmentFiltersanyOptional

blueprintanyOptional

Response

This endpoint returns an object.

dataobject

An app

POST

1 curl -X POST https://api.x.flatfile.com/v1/apps \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '{
6   "name": "Nightly Data Loads",
7   "namespace": "nightly-data",
8   "type": "CUSTOM",
9   "entity": "Sync",
10   "entityPlural": "Syncs",
11   "icon": "<svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"currentColor\" class=\"bi bi-bar-chart-fill\" viewBox=\"0 0 16 16\">\n  <path d=\"M1 11a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1v3a1 1 0 0 1-1 1H2a1 1 0 0 1-1-1zm5-4a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1v7a1 1 0 0 1-1 1H7a1 1 0 0 1-1-1zm5-5a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1v12a1 1 0 0 1-1 1h-2a1 1 0 0 1-1-1z\"/>\n</svg>",
12   "metadata": {
13     "foo": "bar"
14   }
15 }'

200Successful

1 {
2   "data": {
3     "id": "us_app_YOUR_ID",
4     "name": "Nightly Data Loads",
5     "namespace": "nightly-data",
6     "type": "CUSTOM",
7     "entity": "Sync",
8     "entityPlural": "Syncs",
9     "metadata": {
10       "foo": "bar"
11     },
12     "environmentFilters": {
13       "type": [
14         "PROD",
15         "DEV"
16       ],
17       "exclude_ids": [
18         "us_env_123456"
19       ]
20     },
21     "createdAt": "2023-10-30T16:59:45.735Z",
22     "updatedAt": "2023-10-30T16:59:45.735Z",
23     "icon": "<svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"currentColor\" class=\"bi bi-bar-chart-fill\" viewBox=\"0 0 16 16\">\n  <path d=\"M1 11a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1v3a1 1 0 0 1-1 1H2a1 1 0 0 1-1-1zm5-4a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1v7a1 1 0 0 1-1 1H7a1 1 0 0 1-1-1zm5-5a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1v12a1 1 0 0 1-1 1h-2a1 1 0 0 1-1-1z\"/>\n</svg>",
24     "deletedAt": null,
25     "activatedAt": null
26   }
27 }

Built with

1	curl -X POST https://api.x.flatfile.com/v1/apps \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"name": "Nightly Data Loads",
7	"namespace": "nightly-data",
8	"type": "CUSTOM",
9	"entity": "Sync",
10	"entityPlural": "Syncs",
11	"icon": "<svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"currentColor\" class=\"bi bi-bar-chart-fill\" viewBox=\"0 0 16 16\">\n <path d=\"M1 11a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1v3a1 1 0 0 1-1 1H2a1 1 0 0 1-1-1zm5-4a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1v7a1 1 0 0 1-1 1H7a1 1 0 0 1-1-1zm5-5a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1v12a1 1 0 0 1-1 1h-2a1 1 0 0 1-1-1z\"/>\n</svg>",
12	"metadata": {
13	"foo": "bar"
14	}
15	}'

1	{
2	"data": {
3	"id": "us_app_YOUR_ID",
4	"name": "Nightly Data Loads",
5	"namespace": "nightly-data",
6	"type": "CUSTOM",
7	"entity": "Sync",
8	"entityPlural": "Syncs",
9	"metadata": {
10	"foo": "bar"
11	},
12	"environmentFilters": {
13	"type": [
14	"PROD",
15	"DEV"
16	],
17	"exclude_ids": [
18	"us_env_123456"
19	]
20	},
21	"createdAt": "2023-10-30T16:59:45.735Z",
22	"updatedAt": "2023-10-30T16:59:45.735Z",
23	"icon": "<svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"currentColor\" class=\"bi bi-bar-chart-fill\" viewBox=\"0 0 16 16\">\n <path d=\"M1 11a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1v3a1 1 0 0 1-1 1H2a1 1 0 0 1-1-1zm5-4a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1v7a1 1 0 0 1-1 1H7a1 1 0 0 1-1-1zm5-5a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1v12a1 1 0 0 1-1 1h-2a1 1 0 0 1-1-1z\"/>\n</svg>",
24	"deletedAt": null,
25	"activatedAt": null
26	}
27	}