Skip to main content
POST
TypeScript

Authorizations

Authorization
string
header
required

Project-bound Apollo Signal API key. Keys begin with ap_signal_ and must carry the permission shown on the operation.

Path Parameters

projectId
string
required

The ID of the project to create the topic in.

Body

application/json

Topic creation parameters.

Definition and default consent behavior for a new topic.

defaultSubscription
enum<string>
required

State assigned when a contact has no explicit preference for this topic.

Available options:
opt_in,
opt_out
name
string
required

Topic name after trimming; 1 to 200 characters.

Maximum string length: 200
description
string

Optional developer-facing explanation of the topic.

visibility
enum<string>
default:private

Topic visibility. Defaults to private.

Available options:
public,
private

Response

Topic created successfully.

createdAt
string
required
defaultSubscription
string
required
id
string
required
name
string
required
object
string
required
optInCount
integer<int32>
required
optOutCount
integer<int32>
required
projectId
string
required
updatedAt
string
required
visibility
string
required
description
string