Skip to content
Public API
Esc
↑↓navigate↵open⌘Jpreview

Create a project

customerId must be a string here. Runs synchronously and returns the id of the created order — fetch it with GET /project/{id}. Either customerId or contactEmail is required and must resolve to an existing customer.

POST/project
Authorization
AuthorizationAPI key · headerrequired

The Incoming Secret value (<secretId>.<random>), with or without a Bearer prefix.

Request body
application/json
customIdstringrequired

Custom ticket id.

statusNamestringrequired

Name of an existing ticket status.

customerIdstring

Id of the customer, as a string. Alternative to contactEmail.

contactEmailstring

Email of an existing customer. Alternative to customerId.

prioritystring

Ticket priority.

poNumberstring

Purchase order number.

quotationFormRegionIdstring

Id of the quotation form region.

deliveryMethodTypestring

Delivery method type.

deliveryMethodNamestring

Delivery method name.

additionalFilesobject

Downloadable files to attach, keyed by file name; each value is {url, headers}. An object, not an array.

billingAddressobject
Show properties
firstNamestringrequired

First name.

lastNamestringrequired

Last name.

addressstringrequired

Street address.

addressSecondLinestringrequired

Second address line.

citystringrequired

City.

telephonestringrequired

Telephone.

emailstringrequired

Email.

companyNamestring

Company name.

postCodestring

Post code.

countryNamestring

Country name.

countryISOstring

ISO country code.

shippingAddressobject
Show properties
firstNamestringrequired

First name.

lastNamestringrequired

Last name.

addressstringrequired

Street address.

addressSecondLinestringrequired

Second address line.

citystringrequired

City.

telephonestringrequired

Telephone.

emailstringrequired

Email.

companyNamestring

Company name.

postCodestring

Post code.

countryNamestring

Country name.

countryISOstring

ISO country code.

Responses
200

Created. Returns only the id — fetch the full Project with the corresponding GET.

idinteger | stringrequired

Id of the created Project.

Show properties
One of:
integer
integer
string
string
401

Authentication failed. All causes return this identical response.

codeinteger
messagestring
typestring
default

Downstream errors pass through verbatim; x-error-source names the failing service.

codeinteger
messagestring
typestring
Try it
Server
Authorization
Bodyapplication/json
Request
curl -X POST 'https://next.amfg.ai/engine-service/public-api/v1/project' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "customId": "string",
  "statusName": "string",
  "customerId": "string",
  "contactEmail": "string",
  "priority": "string",
  "poNumber": "string",
  "quotationFormRegionId": "string",
  "deliveryMethodType": "string",
  "deliveryMethodName": "string",
  "additionalFiles": {},
  "billingAddress": {
    "firstName": "string",
    "lastName": "string",
    "address": "string",
    "addressSecondLine": "string",
    "city": "string",
    "telephone": "string",
    "email": "string",
    "companyName": "string",
    "postCode": "string",
    "countryName": "string",
    "countryISO": "string"
  },
  "shippingAddress": {
    "firstName": "string",
    "lastName": "string",
    "address": "string",
    "addressSecondLine": "string",
    "city": "string",
    "telephone": "string",
    "email": "string",
    "companyName": "string",
    "postCode": "string",
    "countryName": "string",
    "countryISO": "string"
  }
}'
Response
{
  "id": 0
}