Documentation Index
Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /typeface-management | Type: Application | PCID required: Yes
typeface_management_create_account
Create Team
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
createSharedWorkspaces | boolean | No | — | Create Shared Workspaces |
cloudProvider | string | No | — | Specifies the cloud provider where the team’s data and resources are hosted (either AZURE or GOOGLE). |
displayName | string | No | — | Display Name |
workspaceName | string | No | — | Workspace Name |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"createSharedWorkspaces": {
"type": "boolean",
"description": "Create Shared Workspaces"
},
"cloudProvider": {
"type": "string",
"description": "Specifies the cloud provider where the team's data and resources are hosted (either AZURE or GOOGLE).",
"enum": [
"AZURE",
"GOOGLE"
]
},
"displayName": {
"type": "string",
"description": "Display Name"
},
"workspaceName": {
"type": "string",
"description": "Workspace Name"
}
},
"required": [
"PCID"
]
}
typeface_management_create_audience_in_account
Create Audience
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
accountId | string | Yes | — | Unique identifier for the specific team |
audienceCatalogId | integer | Yes | — | Unique identifier for the audience library |
entitySubType | string | No | — | Entity Sub Type |
ingestionSource | string | No | — | Ingestion Source |
name | string | No | — | The name value |
properties | object | No | — | The properties value |
renditionId | object | No | — | Rendition Id |
sourcePath | string | No | — | Source Path |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountId": {
"type": "string",
"description": "Unique identifier for the specific team"
},
"audienceCatalogId": {
"type": "integer",
"description": "Unique identifier for the audience library"
},
"entitySubType": {
"type": "string",
"description": "Entity Sub Type",
"enum": [
"DEFAULT",
"GENERATED_IMAGE_PARENT",
"DOCUMENT_INTERMEDIATE",
"DOCUMENT_LAYOUT_HTML"
]
},
"ingestionSource": {
"type": "string",
"description": "Ingestion Source"
},
"name": {
"type": "string",
"description": "The name value"
},
"properties": {
"type": "object",
"description": "The properties value",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"ageRangeMin": {
"type": "integer",
"description": "Age Range Min"
},
"ageRangeMax": {
"type": "integer",
"description": "Age Range Max"
},
"gender": {
"type": "string",
"description": "The gender value"
},
"preferences": {
"type": "array",
"description": "The preferences value"
},
"spendingBehavior": {
"type": "array",
"description": "Spending Behavior"
}
}
},
"renditionId": {
"type": "object",
"description": "Rendition Id",
"properties": {
"id": {
"type": "integer",
"description": "The id value"
}
}
},
"sourcePath": {
"type": "string",
"description": "Source Path"
}
},
"required": [
"PCID",
"accountId",
"audienceCatalogId"
]
}
typeface_management_create_project_in_account
Create a Project
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
accountId | string | Yes | — | Unique identifier for the specific team |
name | string | No | — | The name value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountId": {
"type": "string",
"description": "Unique identifier for the specific team"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"PCID",
"accountId"
]
}
typeface_management_delete_account_by_id
Delete Team
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
accountId | string | Yes | — | Unique identifier for the specific team |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountId": {
"type": "string",
"description": "Unique identifier for the specific team"
}
},
"required": [
"PCID",
"accountId"
]
}
typeface_management_delete_audience_in_account
Delete Audience
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
accountId | string | Yes | — | Unique identifier for the specific team |
audienceCatalogId | integer | Yes | — | Unique identifier for the audience library |
audienceId | integer | Yes | — | Unique identifier for the audience |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountId": {
"type": "string",
"description": "Unique identifier for the specific team"
},
"audienceCatalogId": {
"type": "integer",
"description": "Unique identifier for the audience library"
},
"audienceId": {
"type": "integer",
"description": "Unique identifier for the audience"
}
},
"required": [
"PCID",
"accountId",
"audienceCatalogId",
"audienceId"
]
}
typeface_management_delete_project_in_account
Delete Project
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
accountId | string | Yes | — | Unique identifier for the specific team |
projectId | integer | Yes | — | Unique identifier for the specific project |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountId": {
"type": "string",
"description": "Unique identifier for the specific team"
},
"projectId": {
"type": "integer",
"description": "Unique identifier for the specific project"
}
},
"required": [
"PCID",
"accountId",
"projectId"
]
}
typeface_management_discover_identity
Discovery API
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
typeface_management_get_layout_manifests_in_project
Project - Get Layout
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
projectId | integer | Yes | — | Unique identifier for the specific project |
layoutId | integer | Yes | — | Unique identifier for the specific layout manifest |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "Unique identifier for the specific project"
},
"layoutId": {
"type": "integer",
"description": "Unique identifier for the specific layout manifest"
}
},
"required": [
"PCID",
"projectId",
"layoutId"
]
}
typeface_management_get_project_in_account
Get a Project
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
accountId | string | Yes | — | Unique identifier for the specific team |
projectId | integer | Yes | — | Unique identifier for the specific project |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountId": {
"type": "string",
"description": "Unique identifier for the specific team"
},
"projectId": {
"type": "integer",
"description": "Unique identifier for the specific project"
}
},
"required": [
"PCID",
"accountId",
"projectId"
]
}
typeface_management_manage_audience_in_account
Manage Audience
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
accountId | string | Yes | — | Unique identifier for the specific team |
audienceCatalogId | integer | Yes | — | Unique identifier for the audience library |
audienceId | integer | Yes | — | Unique identifier for the audience |
entitySubType | string | No | — | Entity Sub Type |
ingestionSource | string | No | — | Ingestion Source |
name | string | No | — | The name value |
properties | object | No | — | The properties value |
renditionId | object | No | — | Rendition Id |
sourcePath | string | No | — | Source Path |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountId": {
"type": "string",
"description": "Unique identifier for the specific team"
},
"audienceCatalogId": {
"type": "integer",
"description": "Unique identifier for the audience library"
},
"audienceId": {
"type": "integer",
"description": "Unique identifier for the audience"
},
"entitySubType": {
"type": "string",
"description": "Entity Sub Type",
"enum": [
"DEFAULT",
"GENERATED_IMAGE_PARENT",
"DOCUMENT_INTERMEDIATE",
"DOCUMENT_LAYOUT_HTML"
]
},
"ingestionSource": {
"type": "string",
"description": "Ingestion Source"
},
"name": {
"type": "string",
"description": "The name value"
},
"properties": {
"type": "object",
"description": "The properties value",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"ageRangeMin": {
"type": "integer",
"description": "Age Range Min"
},
"ageRangeMax": {
"type": "integer",
"description": "Age Range Max"
},
"gender": {
"type": "string",
"description": "The gender value"
},
"preferences": {
"type": "array",
"description": "The preferences value"
},
"spendingBehavior": {
"type": "array",
"description": "Spending Behavior"
}
}
},
"renditionId": {
"type": "object",
"description": "Rendition Id",
"properties": {
"id": {
"type": "integer",
"description": "The id value"
}
}
},
"sourcePath": {
"type": "string",
"description": "Source Path"
}
},
"required": [
"PCID",
"accountId",
"audienceCatalogId",
"audienceId"
]
}
typeface_management_query_accounts_in_org
Query Teams
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
orgId | string | Yes | — | Org Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"orgId": {
"type": "string",
"description": "Org Id"
}
},
"required": [
"PCID",
"orgId"
]
}
typeface_management_query_audience_catalogs_in_account
List Audience Catlogs
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
accountId | string | Yes | — | Unique identifier for the specific team |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountId": {
"type": "string",
"description": "Unique identifier for the specific team"
}
},
"required": [
"PCID",
"accountId"
]
}
typeface_management_query_audiences_in_account
List Audiences
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
accountId | string | Yes | — | Unique identifier for the specific team |
audienceCatalogId | integer | Yes | — | Unique identifier for the audience library |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountId": {
"type": "string",
"description": "Unique identifier for the specific team"
},
"audienceCatalogId": {
"type": "integer",
"description": "Unique identifier for the audience library"
}
},
"required": [
"PCID",
"accountId",
"audienceCatalogId"
]
}
typeface_management_query_layout_manifests_in_project
Project - List Layouts
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
projectId | integer | Yes | — | Unique identifier for the specific project |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "Unique identifier for the specific project"
}
},
"required": [
"PCID",
"projectId"
]
}
typeface_management_query_projects_in_account_1
List Projects
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
accountId | string | Yes | — | Unique identifier for the specific team |
workspaceSubType | string | No | — | Workspace Sub Type |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountId": {
"type": "string",
"description": "Unique identifier for the specific team"
},
"workspaceSubType": {
"type": "string",
"description": "Workspace Sub Type",
"enum": [
"ALCHEMIST",
"WEAVER",
"BATCH_OUTPUT",
"DEFAULT",
"BRAND_KIT_LIBRARY",
"DECORATION_LIBRARY",
"AUDIENCE_LIBRARY",
"LOGO_LIBRARY"
]
}
},
"required": [
"PCID",
"accountId"
]
}
typeface_management_update_project_in_account
Update Project
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
accountId | string | Yes | — | Unique identifier for the specific team |
projectId | integer | Yes | — | Unique identifier for the specific project |
name | string | No | — | The name value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountId": {
"type": "string",
"description": "Unique identifier for the specific team"
},
"projectId": {
"type": "integer",
"description": "Unique identifier for the specific project"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"PCID",
"accountId",
"projectId"
]
}