Create a workspace-owned campaign type

POST /campaign-types

Create a workspace-owned campaign type

cURL

curl --request POST \
  --url https://api.pineyard.ai/campaign-types \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "extractionKeys": [
    {
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "description": "<string>"
}
'

201

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "extractionKeys": [
    {
      "name": "<string>",
      "type": "string",
      "description": "<string>"
    }
  ],
  "status": "ACTIVE",
  "isOwn": true
}

Required scope: campaign_types.edit

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Body

application/json

name · string · required

Required string length: 1 - 80

extractionKeys · object[] · required

Required array length: 1 - 40 elements

Show child attributes

description · string | null

Maximum string length: 500

status · enum<string>

Available options: ACTIVE, ARCHIVED

Response

201

application/json

Created

id · string · required

name · string · required

description · string | null · required

extractionKeys · object[] · required

Show child attributes

status · enum<string> · required

Available options: ACTIVE, ARCHIVED

isOwn · boolean · required