Skip to main content
POST
/
projects
/
v1
/
ad
Create a ad project
curl --request POST \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/projects/v1/ad \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>' \
  --data '
{
  "name": "Renovation Bat A",
  "object": "Full renovation of building A",
  "assignedUserIds": [
    1,
    2,
    3
  ],
  "scheduledAt": "2025-06-01T00:00:00.000Z",
  "folderId": 2
}
'
{
  "data": {
    "id": 1,
    "name": "Renovation Bat A",
    "object": "Full renovation of building A",
    "scheduledAt": "2025-06-01T00:00:00.000Z",
    "organizationId": 1,
    "folderId": 2,
    "deletedAt": "2024-12-09T14:23:00.000Z",
    "updatedAt": "2024-12-09T14:23:00.000Z",
    "createdAt": "2024-01-15T08:45:00.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
content-type
string
required

Content type, must be "application/json".

Allowed value: "application/json"
​
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Body

application/json

Details required to create a ad project

​
name
string
required

Name of the project.

Example:

"Renovation Bat A"

​
object
string

Object/description of the project.

Example:

"Full renovation of building A"

​
assignedUserIds
integer[]

Unique identifiers of the users assigned to the project.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
scheduledAt

Scheduled date of the project.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2025-06-01T00:00:00.000Z"

​
folderId
integer

Unique identifier of the folder the project is in.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

2

Response

201 - application/json

Ad project created successfully

​
data
object
required