PublicApiCreateCampaign
curl --request POST \
--url https://sandbox.api.app.firstsales.io/api/v1/organizations/{orgId}/workspaces/{wsId}/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"audience": {
"targetAudience": "<string>",
"industry": "<string>",
"geography": {
"country": "<string>",
"state": "<string>",
"city": "<string>"
}
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
audience: {
targetAudience: '<string>',
industry: '<string>',
geography: {country: '<string>', state: '<string>', city: '<string>'}
}
})
};
fetch('https://sandbox.api.app.firstsales.io/api/v1/organizations/{orgId}/workspaces/{wsId}/campaigns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"campaign": {
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"description": "<string>",
"progress": 0,
"audience": {
"targetAudience": "<string>",
"industry": "<string>",
"geography": {
"country": "<string>",
"state": "<string>",
"city": "<string>"
}
},
"stopOnReply": true,
"handleOOO": true,
"sendWindow": {
"start": "09:00",
"end": "17:00",
"timezone": "auto",
"activeDays": [
"mon",
"tue",
"wed",
"thu",
"fri"
]
},
"startedAt": "2023-11-07T05:31:56Z",
"lastSendAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": {}
}
}Campaigns
PublicApiCreateCampaign
POST /api/v1/organizations//workspaces//campaigns
POST
/
api
/
v1
/
organizations
/
{orgId}
/
workspaces
/
{wsId}
/
campaigns
PublicApiCreateCampaign
curl --request POST \
--url https://sandbox.api.app.firstsales.io/api/v1/organizations/{orgId}/workspaces/{wsId}/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"audience": {
"targetAudience": "<string>",
"industry": "<string>",
"geography": {
"country": "<string>",
"state": "<string>",
"city": "<string>"
}
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
audience: {
targetAudience: '<string>',
industry: '<string>',
geography: {country: '<string>', state: '<string>', city: '<string>'}
}
})
};
fetch('https://sandbox.api.app.firstsales.io/api/v1/organizations/{orgId}/workspaces/{wsId}/campaigns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"campaign": {
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"description": "<string>",
"progress": 0,
"audience": {
"targetAudience": "<string>",
"industry": "<string>",
"geography": {
"country": "<string>",
"state": "<string>",
"city": "<string>"
}
},
"stopOnReply": true,
"handleOOO": true,
"sendWindow": {
"start": "09:00",
"end": "17:00",
"timezone": "auto",
"activeDays": [
"mon",
"tue",
"wed",
"thu",
"fri"
]
},
"startedAt": "2023-11-07T05:31:56Z",
"lastSendAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": {}
}
}Use this endpoint through the Developer API or the matching
firstsales CLI command when available. Responses use the stable FirstSales public error envelope.Authorizations
FirstSales developer API key bearer token (fs-key-*).
Headers
Minimum string length:
1Body
application/json
Required string length:
1 - 200Available options:
outreach, marketing Available options:
meeting, demo, download, order, reply, custom Maximum string length:
1000Show child attributes
Show child attributes
Available options:
template, autopilot Response
Campaign created
Show child attributes
Show child attributes
⌘I