POST projects

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	globally unique identifier	None.
Name	string	None.
CreatedDate	date	None.
ModifiedDate	date	None.
Status	integer	None.
Product	Product	None.
Background	Background	None.
Stamps	Collection of Stamp	None.
Assets	Collection of ProjectAsset	None.
ARAsset	ARAsset	None.
BackgroundId	globally unique identifier	None.
LayoutMaskId	globally unique identifier	None.
ProductId	globally unique identifier	None.
UserID	globally unique identifier	None.
GuestUserId	globally unique identifier	None.
PreviewImageDetails	string	None.
FormTemplate	string	None.
s7ImageVersion	string	None.
FinalVingetteImageLocation	string	None.
FinalFlatImageLocation	string	None.
FinalFlatImageBlobLocation	string	None.
PreviewFlatImageLocation	string	None.
FinalFlatFilename	string	None.
IsDefaultProjectName	boolean	None.
ProjectImageSource	string	None.
FinalImageSource	integer	None.
ArtboardFlatImage	Collection of byte	None.
ArtboardFlatImageLocation	string	None.
SiteCode	string	None.
SiteCodeID	integer	None.
ShowS7NoBackgroundExistsWarning	boolean	None.
EditRequestDateUTC	date	None.
IsCSREditing	boolean	None.
FinalFlatImage	Collection of byte	None.

Request Formats

application/json, text/json, text/html

Sample:

{
  "Id": "432225ed-b7b6-46a5-b5d0-c6ad83048d75",
  "Name": "sample string 2",
  "CreatedDate": "2026-08-17T21:58:01.4793974+00:00",
  "ModifiedDate": "2026-08-17T21:58:01.4793974+00:00",
  "Status": 5,
  "Product": {
    "Id": "2ca04534-1cd0-4333-bba0-fd0ee6234c15",
    "Name": "sample string 2",
    "Size": 3,
    "Category": "sample string 4",
    "Price": 5.1,
    "WrapHeight": 6.1,
    "WrapWidth": 7.1,
    "Backgrounds": [
      {
        "Id": "07f61b8d-7a98-4dc9-8d33-5d76bb510fb8",
        "Name": "sample string 2",
        "CategoryNames": "sample string 3",
        "Url": "sample string 4",
        "IsDefault": true,
        "LicenseID": "03272c3a-da1a-4e5a-aa99-0ec5ac919f07",
        "IsLicensed": true,
        "PDPFG": "sample string 7",
        "PurchaseFG": "sample string 8",
        "PurchasePrice": 1.1,
        "LayoutRulesCompareResult": "sample string 9",
        "IsSameLayoutAvailable": true,
        "IsSameRulesAvailable": true,
        "AddedBy": "sample string 12",
        "IsMonogram": true,
        "IsAR": true
      },
      {
        "Id": "07f61b8d-7a98-4dc9-8d33-5d76bb510fb8",
        "Name": "sample string 2",
        "CategoryNames": "sample string 3",
        "Url": "sample string 4",
        "IsDefault": true,
        "LicenseID": "03272c3a-da1a-4e5a-aa99-0ec5ac919f07",
        "IsLicensed": true,
        "PDPFG": "sample string 7",
        "PurchaseFG": "sample string 8",
        "PurchasePrice": 1.1,
        "LayoutRulesCompareResult": "sample string 9",
        "IsSameLayoutAvailable": true,
        "IsSameRulesAvailable": true,
        "AddedBy": "sample string 12",
        "IsMonogram": true,
        "IsAR": true
      }
    ],
    "Form": null,
    "FGCode": "sample string 8",
    "IsActive": true,
    "SiteCodeID": 10
  },
  "Background": {
    "Id": "07f61b8d-7a98-4dc9-8d33-5d76bb510fb8",
    "Name": "sample string 2",
    "CategoryNames": "sample string 3",
    "Url": "sample string 4",
    "IsDefault": true,
    "LicenseID": "03272c3a-da1a-4e5a-aa99-0ec5ac919f07",
    "IsLicensed": true,
    "PDPFG": "sample string 7",
    "PurchaseFG": "sample string 8",
    "PurchasePrice": 1.1,
    "LayoutRulesCompareResult": "sample string 9",
    "IsSameLayoutAvailable": true,
    "IsSameRulesAvailable": true,
    "AddedBy": "sample string 12",
    "IsMonogram": true,
    "IsAR": true
  },
  "Stamps": [
    {
      "Id": "5c919cd3-a34a-4775-9d1b-9fe11cda9dee",
      "Name": "sample string 2",
      "CategoryNames": "sample string 3",
      "Top": 4.1,
      "Left": 5.1,
      "Height": 6.1,
      "Width": 7.1,
      "Layer": 8,
      "Rotation": 9,
      "Url": "sample string 10",
      "AssetId": "ab0c2e14-f74f-4d58-baa5-a3e340cf6615"
    },
    {
      "Id": "5c919cd3-a34a-4775-9d1b-9fe11cda9dee",
      "Name": "sample string 2",
      "CategoryNames": "sample string 3",
      "Top": 4.1,
      "Left": 5.1,
      "Height": 6.1,
      "Width": 7.1,
      "Layer": 8,
      "Rotation": 9,
      "Url": "sample string 10",
      "AssetId": "ab0c2e14-f74f-4d58-baa5-a3e340cf6615"
    }
  ],
  "Assets": [
    {
      "ProjectAssetId": "1b3cc385-24d6-4ebb-89a1-8bfc46989545",
      "Height": 2.1,
      "Width": 3.1,
      "AssetHeight": 4.1,
      "AssetWidth": 5.1,
      "Left": 6.1,
      "Top": 7.1,
      "AssetId": "206a99ee-1e1a-4588-a42e-259b20e9d796",
      "FlipX": true,
      "FlipY": true,
      "Rotation": 11.1,
      "zIndex": 12,
      "AssetType": 13,
      "DesignerPayload": "sample string 14",
      "LayoutMaskItemId": "508cdc7c-2f6a-4704-8661-16ca19755b4a",
      "ImageUrl": "sample string 15",
      "CropPayload": "sample string 16",
      "Brightness": 17.1,
      "Saturation": 18.1,
      "ImageFilterType": "sample string 19"
    },
    {
      "ProjectAssetId": "1b3cc385-24d6-4ebb-89a1-8bfc46989545",
      "Height": 2.1,
      "Width": 3.1,
      "AssetHeight": 4.1,
      "AssetWidth": 5.1,
      "Left": 6.1,
      "Top": 7.1,
      "AssetId": "206a99ee-1e1a-4588-a42e-259b20e9d796",
      "FlipX": true,
      "FlipY": true,
      "Rotation": 11.1,
      "zIndex": 12,
      "AssetType": 13,
      "DesignerPayload": "sample string 14",
      "LayoutMaskItemId": "508cdc7c-2f6a-4704-8661-16ca19755b4a",
      "ImageUrl": "sample string 15",
      "CropPayload": "sample string 16",
      "Brightness": 17.1,
      "Saturation": 18.1,
      "ImageFilterType": "sample string 19"
    }
  ],
  "ARAsset": {
    "Id": "21a854e1-4751-4412-bda7-456d1b275a98",
    "IsVideoEncoded": true,
    "IsVideoTrimmed": true,
    "IsPortraitVideo": true,
    "IsKeepLowResolutionVideo": true,
    "PublishedVideoURL": "sample string 6",
    "OriginalAssetURL": "sample string 7",
    "VideoThumbnailURL": "sample string 8",
    "CreatedDateUTC": "2026-08-17T21:58:01.4793974+00:00",
    "ModifiedDateUTC": "2026-08-17T21:58:01.4793974+00:00",
    "VideoStatus": 11,
    "IsTemp": true,
    "ErrorText": "sample string 13",
    "ARVideoUploadStatus": 0
  },
  "BackgroundId": "ec45187b-0431-43cd-b8b5-81244cf9ec69",
  "LayoutMaskId": "52eeab67-b7e9-4f67-8955-50dcbefb2940",
  "ProductId": "e47872f4-ae08-47a2-8903-b7b4af98daf3",
  "UserID": "b82cae14-1378-49ca-a49d-00edcc1424e1",
  "GuestUserId": "1d1ea6e9-396d-43e1-80c2-cde50d4b4abb",
  "PreviewImageDetails": "sample string 10",
  "FormTemplate": "sample string 11",
  "s7ImageVersion": "sample string 12",
  "FinalVingetteImageLocation": "sample string 13",
  "FinalFlatImageLocation": "sample string 14",
  "FinalFlatImageBlobLocation": "sample string 15",
  "PreviewFlatImageLocation": "sample string 16",
  "FinalFlatFilename": "sample string 17",
  "IsDefaultProjectName": true,
  "ProjectImageSource": "sample string 19",
  "FinalImageSource": 20,
  "ArtboardFlatImage": "QEA=",
  "ArtboardFlatImageLocation": "sample string 21",
  "SiteCode": "sample string 22",
  "SiteCodeID": 23,
  "ShowS7NoBackgroundExistsWarning": true,
  "EditRequestDateUTC": "2026-08-17T21:58:01.4793974+00:00",
  "IsCSREditing": true,
  "FinalFlatImage": "QEA="
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'Tervis.Customyzer.Services.Web.API.Models.Form' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'Tervis.Customyzer.Services.Web.API.Models.Form' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Project'.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.