Projects

List projects in workspace

GET/workspaces/{workspaceId}/projects

Path parameters

workspaceId*string

Query parameters

Response

200404

OK

Body

application/json

results*array of Touchpoints_Project (object)

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/projects', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "type": "chatwidget",
      "scope": 0,
      "supportedPlatforms": [
        "all"
      ],
      "locales": [
        "en"
      ],
      "activeResourceId": "123e4567-e89b-12d3-a456-426614174000",
      "draftCount": 0,
      "pendingCount": 0,
      "activeCount": 0,
      "inactiveCount": 0,
      "createdAt": "2024-12-21T11:49:08.997Z",
      "updatedAt": "2024-12-21T11:49:08.997Z",
      "approvedTemplateChannelsId": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "approvedTemplateChannelGroupIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "suites": [
        "marketing"
      ],
      "clonedFrom": "123e4567-e89b-12d3-a456-426614174000",
      "metadata": [
        {
          "key": "text",
          "value": "text"
        }
      ]
    }
  ],
  "nextPageToken": "text"
}

Create project

POST/workspaces/{workspaceId}/projects

Path parameters

workspaceId*string

Body

application/json

namestring

descriptionstring

type*Touchpoints_ProjectType (enum)

enum for all the different project types Touchpoints API supports.

chatwidgetformknowledgeBasedeepLinkchannelTemplatewebsitehtmlEmailpopuphelpcenter

scopeTouchpoints_ProjectScope (enum)

dictionary:

• 0 DEFAULT: This should indicate that the project is of our current scope (can be used across all BirdCRM services).
• 1 SAVED_TEMPLATE: This should indicate that the project is a saved template, meaning that it came from extending one of BirdCRM library templates. They can be used for creating other Projects, such as inline campaigns and flows content.
• 2 INLINE_MESSAGE: This should indicate that the project is an inline message, meaning that it was created from a campaign or flow using a library template or a saved template. They are linked to an specific instance of other BirdCRM services (Campaigns, Flows, etc.).
• 3 (PLATFORM_REVIEWED_TEMPLATE): This should indicate that the project is a platform reviewed template, meaning the template must go through a external platform review.

0123

suitesarray of Touchpoints_SuiteType (enum)

Response

201404409422

Created

Body

application/json

id*string (uuid)

workspaceIdstring (uuid)

namestring

descriptionstring

typeTouchpoints_ProjectType (enum)

enum for all the different project types Touchpoints API supports.

chatwidgetformknowledgeBasedeepLinkchannelTemplatewebsitehtmlEmailpopuphelpcenter

scopeTouchpoints_ProjectScope (enum)

dictionary:

• 0 DEFAULT: This should indicate that the project is of our current scope (can be used across all BirdCRM services).
• 1 SAVED_TEMPLATE: This should indicate that the project is a saved template, meaning that it came from extending one of BirdCRM library templates. They can be used for creating other Projects, such as inline campaigns and flows content.
• 2 INLINE_MESSAGE: This should indicate that the project is an inline message, meaning that it was created from a campaign or flow using a library template or a saved template. They are linked to an specific instance of other BirdCRM services (Campaigns, Flows, etc.).
• 3 (PLATFORM_REVIEWED_TEMPLATE): This should indicate that the project is a platform reviewed template, meaning the template must go through a external platform review.

0123

supportedPlatformsnullable Touchpoints_PlatformList (array of enum)

localesnullable array of Touchpoints_LocaleEnum (enum)

activeResourceIdnullable string (uuid)

draftCountnumber

pendingCountnumber

activeCountnumber

inactiveCountnumber

createdAt*string (date-time)

updatedAtnullable string (date-time)

approvedTemplateChannelsIdnullable array of string (uuid)

approvedTemplateChannelGroupIdsnullable array of string (uuid)

suitesarray of Touchpoints_SuiteType (enum)

clonedFromnullable string (uuid)

The ID of the project that this project was cloned from. This field is only present if this project was cloned from another project.

metadataTouchpoints_Metadata (array of object)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/projects', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "chatwidget"
    }),
});
const data = await response.json();

Response

201404409422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "type": "chatwidget",
  "scope": 0,
  "supportedPlatforms": [
    "all"
  ],
  "locales": [
    "en"
  ],
  "activeResourceId": "123e4567-e89b-12d3-a456-426614174000",
  "draftCount": 0,
  "pendingCount": 0,
  "activeCount": 0,
  "inactiveCount": 0,
  "createdAt": "2024-12-21T11:49:08.997Z",
  "updatedAt": "2024-12-21T11:49:08.997Z",
  "approvedTemplateChannelsId": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "approvedTemplateChannelGroupIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "suites": [
    "marketing"
  ],
  "clonedFrom": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

Get Project

GET/workspaces/{workspaceId}/projects/{projectId}

Path parameters

workspaceId*string

projectId*string

Response

200404

OK

Body

application/json

id*string (uuid)

workspaceIdstring (uuid)

namestring

descriptionstring

typeTouchpoints_ProjectType (enum)

enum for all the different project types Touchpoints API supports.

chatwidgetformknowledgeBasedeepLinkchannelTemplatewebsitehtmlEmailpopuphelpcenter

scopeTouchpoints_ProjectScope (enum)

dictionary:

• 0 DEFAULT: This should indicate that the project is of our current scope (can be used across all BirdCRM services).
• 1 SAVED_TEMPLATE: This should indicate that the project is a saved template, meaning that it came from extending one of BirdCRM library templates. They can be used for creating other Projects, such as inline campaigns and flows content.
• 2 INLINE_MESSAGE: This should indicate that the project is an inline message, meaning that it was created from a campaign or flow using a library template or a saved template. They are linked to an specific instance of other BirdCRM services (Campaigns, Flows, etc.).
• 3 (PLATFORM_REVIEWED_TEMPLATE): This should indicate that the project is a platform reviewed template, meaning the template must go through a external platform review.

0123

supportedPlatformsnullable Touchpoints_PlatformList (array of enum)

localesnullable array of Touchpoints_LocaleEnum (enum)

activeResourceIdnullable string (uuid)

draftCountnumber

pendingCountnumber

activeCountnumber

inactiveCountnumber

createdAt*string (date-time)

updatedAtnullable string (date-time)

approvedTemplateChannelsIdnullable array of string (uuid)

approvedTemplateChannelGroupIdsnullable array of string (uuid)

suitesarray of Touchpoints_SuiteType (enum)

clonedFromnullable string (uuid)

The ID of the project that this project was cloned from. This field is only present if this project was cloned from another project.

metadataTouchpoints_Metadata (array of object)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/projects/{projectId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "type": "chatwidget",
  "scope": 0,
  "supportedPlatforms": [
    "all"
  ],
  "locales": [
    "en"
  ],
  "activeResourceId": "123e4567-e89b-12d3-a456-426614174000",
  "draftCount": 0,
  "pendingCount": 0,
  "activeCount": 0,
  "inactiveCount": 0,
  "createdAt": "2024-12-21T11:49:08.997Z",
  "updatedAt": "2024-12-21T11:49:08.997Z",
  "approvedTemplateChannelsId": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "approvedTemplateChannelGroupIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "suites": [
    "marketing"
  ],
  "clonedFrom": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

Update Project

PATCH/workspaces/{workspaceId}/projects/{projectId}

Path parameters

workspaceId*string

projectId*string

Body

application/json

namenullable string

descriptionnullable string

typenullable string

suitesarray of Touchpoints_SuiteType (enum)

Response

200404422

Updated

Body

application/json

id*string (uuid)

workspaceIdstring (uuid)

namestring

descriptionstring

typeTouchpoints_ProjectType (enum)

enum for all the different project types Touchpoints API supports.

chatwidgetformknowledgeBasedeepLinkchannelTemplatewebsitehtmlEmailpopuphelpcenter

scopeTouchpoints_ProjectScope (enum)

dictionary:

• 0 DEFAULT: This should indicate that the project is of our current scope (can be used across all BirdCRM services).
• 1 SAVED_TEMPLATE: This should indicate that the project is a saved template, meaning that it came from extending one of BirdCRM library templates. They can be used for creating other Projects, such as inline campaigns and flows content.
• 2 INLINE_MESSAGE: This should indicate that the project is an inline message, meaning that it was created from a campaign or flow using a library template or a saved template. They are linked to an specific instance of other BirdCRM services (Campaigns, Flows, etc.).
• 3 (PLATFORM_REVIEWED_TEMPLATE): This should indicate that the project is a platform reviewed template, meaning the template must go through a external platform review.

0123

supportedPlatformsnullable Touchpoints_PlatformList (array of enum)

localesnullable array of Touchpoints_LocaleEnum (enum)

activeResourceIdnullable string (uuid)

draftCountnumber

pendingCountnumber

activeCountnumber

inactiveCountnumber

createdAt*string (date-time)

updatedAtnullable string (date-time)

approvedTemplateChannelsIdnullable array of string (uuid)

approvedTemplateChannelGroupIdsnullable array of string (uuid)

suitesarray of Touchpoints_SuiteType (enum)

clonedFromnullable string (uuid)

The ID of the project that this project was cloned from. This field is only present if this project was cloned from another project.

metadataTouchpoints_Metadata (array of object)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/projects/{projectId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "type": "chatwidget",
  "scope": 0,
  "supportedPlatforms": [
    "all"
  ],
  "locales": [
    "en"
  ],
  "activeResourceId": "123e4567-e89b-12d3-a456-426614174000",
  "draftCount": 0,
  "pendingCount": 0,
  "activeCount": 0,
  "inactiveCount": 0,
  "createdAt": "2024-12-21T11:49:08.997Z",
  "updatedAt": "2024-12-21T11:49:08.997Z",
  "approvedTemplateChannelsId": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "approvedTemplateChannelGroupIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "suites": [
    "marketing"
  ],
  "clonedFrom": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

Delete project

DELETE/workspaces/{workspaceId}/projects/{projectId}

Path parameters

workspaceId*string

projectId*string

Response

204404409

Deleted

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/projects/{projectId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

404409

{
  "code": "text",
  "message": "text"
}