Skip to main content
POST
Record where a new workspace came from

Authorizations

X-API-Key
string
header
required

Body

application/json

The source a new workspace's first link carried, sent once after signup.

src
string | null

The marketing site's own source tag from the register link's src parameter, <lane>-<slug>[-<slot>], for example blog-what-is-data-enrichment-moment.

Required string length: 1 - 100
Pattern: ^[a-z0-9-]+$
utm_campaign
string | null

The register link's utm_campaign parameter, if it had one.

Required string length: 1 - 100
Pattern: ^[a-z0-9._-]+$
utm_medium
string | null

The register link's utm_medium parameter, if it had one.

Required string length: 1 - 100
Pattern: ^[a-z0-9._-]+$
utm_source
string | null

The register link's utm_source parameter, if it had one.

Required string length: 1 - 100
Pattern: ^[a-z0-9._-]+$

Response

Successful Response

The outcome of recording a signup source.

Always 200 for a well formed body. A workspace that already has a source keeps it, and one that is no longer registering gets none: both report recorded: false, because neither is something to alarm a new user about.

recorded
boolean
required

Whether this call recorded the source for the workspace.