# Initialize document
- Operation ID: `initializeDocumentPost`
- HTTP method: `POST`
- Path: `/schema-service/v2/documents/createNew`
- [Human-readable API reference](https://hub.synerise.com/api-reference/asset-management#tag/Documents/operation/initializeDocumentPost)
## Self-contained OpenAPI method
The fenced document below contains this method's documentation and all of its local references. It is self-contained; no category or master specification fetch is required.
```yaml
openapi: 3.0.0
info:
title: Synerise Public API
version: 1.9.1
paths:
/schema-service/v2/documents/createNew:
post:
tags:
- Documents
summary: Initialize document
description: |
Create a new document. It is created as a blank, without any conditions.
---
**API consumers:** Workspace (Business Profile), Synerise User
**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`
**User role permission required:** `assets_docs: create`
operationId: initializeDocumentPost
security:
- JWT: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: If no name is provided, defaults to "Unnamed document" or Screen View Campaign" (depending on what you are initializing).
directory:
type: string
format: uuid
description: If no directory is provided, the default directory is used.
responses:
"200":
description: Document initialized
content:
application/json:
schema:
type: object
description: Data of the document
required:
- docId
- name
- status
- scheduled
- authorId
- directoryId
properties:
docId:
type: string
format: uuid
description: UUID of the document
name:
type: string
description: Name of the document
status:
type: string
enum:
- DRAFT
- ACTIVE
- SCHEDULED
- PAUSED
- FINISHED
description: Filter by status
authorId:
type: integer
format: int64
description: ID of the user who created the document
directoryId:
type: string
format: uuid
description: UUID of the directory where the document is saved
scheduled:
type: boolean
description: Informs if the document has a defined schedule. Documents scheduled to be published immediately after activation are considered to be scheduled, so only a draft document can have this property at `false`. Copied documents inherit the schedule of their source document.
createdAt:
type: string
description: Creation date
format: date-time
updatedAt:
type: string
format: date-time
description: Last update time
deletedAt:
type: string
format: date-time
description: Deletion time, if applicable
nullable: true
"400":
description: See error message for details
content:
application/json:
schema:
type: object
properties:
timestamp:
type: string
format: date-time
description: Time when the error occurred
errorCode:
type: string
description: |
Code of the error, needed for troubleshooting
See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html)
status:
type: integer
description: Error's HTTP status code
message:
type: string
description: Description of the problem
"401":
description: "Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc."
content:
application/json:
schema:
type: object
properties:
timestamp:
type: string
description: Time when the error occurred
error:
type: string
description: Summary of the error
message:
type: string
description: Description of the problem
status:
type: integer
format: int32
description: HTTP status code
"403":
description: Forbidden; insufficient permissions
content:
application/json:
schema:
type: object
properties:
timestamp:
type: string
description: Time when the error occurred
error:
type: string
description: Summary of the error
message:
type: string
description: Description of the problem
status:
type: integer
format: int32
description: HTTP status code
"404":
description: Resource not found
content:
application/json:
schema:
type: object
properties:
timestamp:
type: string
format: date-time
description: Time when the error occurred
errorCode:
type: string
description: |
Code of the error, needed for troubleshooting
See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html)
status:
type: integer
description: Error's HTTP status code
message:
type: string
description: Description of the problem
"500":
description: See error message for details
content:
application/json:
schema:
type: object
properties:
timestamp:
type: string
format: date-time
description: Time when the error occurred
errorCode:
type: string
description: |
Code of the error, needed for troubleshooting
See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html)
status:
type: integer
description: Error's HTTP status code
message:
type: string
description: Description of the problem
x-snr-doc-urls:
- /api-reference/asset-management#tag/Documents/operation/initializeDocumentPost
x-codeSamples:
- lang: cURL
label: cURL
source: |-
curl --request POST \
--url https://api.synerise.com/schema-service/v2/documents/createNew \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
--header 'content-type: application/json' \
--data '{"name":"string","directory":"5277859d-f92c-478c-acab-7680a97fea68"}'
- lang: Python
label: Python
source: |-
import http.client
conn = http.client.HTTPSConnection("api.synerise.com")
payload = "{\"name\":\"string\",\"directory\":\"5277859d-f92c-478c-acab-7680a97fea68\"}"
headers = {
'Authorization': "Bearer REPLACE_BEARER_TOKEN",
'content-type': "application/json"
}
conn.request("POST", "/schema-service/v2/documents/createNew", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
- lang: JavaScript
label: JavaScript
source: |-
const data = JSON.stringify({
"name": "string",
"directory": "5277859d-f92c-478c-acab-7680a97fea68"
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://api.synerise.com/schema-service/v2/documents/createNew");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
xhr.setRequestHeader("content-type", "application/json");
xhr.send(data);
- lang: Node.js
label: Node.js
source: |-
const http = require("https");
const options = {
"method": "POST",
"hostname": "api.synerise.com",
"port": null,
"path": "/schema-service/v2/documents/createNew",
"headers": {
"Authorization": "Bearer REPLACE_BEARER_TOKEN",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({name: 'string', directory: '5277859d-f92c-478c-acab-7680a97fea68'}));
req.end();
- lang: PHP
label: PHP
source: |-
setUrl('https://api.synerise.com/schema-service/v2/documents/createNew');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',
'content-type' => 'application/json'
]);
$request->setBody('{"name":"string","directory":"5277859d-f92c-478c-acab-7680a97fea68"}');
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
- lang: Java
label: Java
source: |-
HttpResponse response = Unirest.post("https://api.synerise.com/schema-service/v2/documents/createNew")
.header("Authorization", "Bearer REPLACE_BEARER_TOKEN")
.header("content-type", "application/json")
.body("{\"name\":\"string\",\"directory\":\"5277859d-f92c-478c-acab-7680a97fea68\"}")
.asString();
servers:
- description: Microsoft Azure EU
url: https://api.synerise.com
- description: Microsoft Azure USA
url: https://api.azu.synerise.com
- description: Google Cloud Platform
url: https://api.geb.synerise.com
tags:
- name: Documents
components:
securitySchemes:
JWT:
type: http
scheme: bearer
description: |-
JWT Bearer token. The header looks like this: `Bearer {JWT}`
Remember to include the space between 'Bearer' and the token.
Generate a token via the **Authorization** endpoints.
```