Skip to content
OpenGTM

Add Source Column

POST
/api/workbooks/{workbook_id}/sources
curl --request POST \
  --url http://localhost:8000/api/workbooks/example/sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "channels": {}, "companies": [ "example" ], "from_column": "", "geo": "", "icp": {}, "kind": "icp", "max_per_company": 10, "max_searches": 100, "name": "Source", "seniority": "", "source": {}, "target_rows": 0, "titles": [ "example" ] }'

Add a source column (ICP-driven, or people_search) to a workbook.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workbook_id
required
Workbook Id
string

Header Parameters

Section titled “Header Parameters”
x-workspace-id
Any of:
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
SourceColumnRequest
object
channels
Channels
object
key
additional properties
any
companies
Companies
Array<string>
from_column
From Column
string
""
geo
Geo
string
""
icp
Icp
object
key
additional properties
any
kind
Kind
string
default: icp
max_per_company
Max Per Company
integer
default: 10
max_searches
Max Searches
integer
default: 100
name
Name
string
default: Source
seniority
Seniority
string
""
source
Source
object
key
additional properties
any
target_rows
Target Rows
integer
0
titles
Titles
Array<string>

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Examplegenerated
example

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}