PublicApiSendCampaignTestEmail
curl --request POST \
--url https://sandbox.api.app.firstsales.io/api/v1/organizations/{orgId}/workspaces/{wsId}/campaigns/{campaignId}/test-email \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"connectorId": "<string>",
"savedCampaignVersion": "<string>",
"readinessVersion": "<string>",
"idempotencyKey": "<string>",
"confirmation": {
"token": "<string>",
"connectorId": "<string>",
"recipientMemberId": "<string>",
"renderedSubject": "<string>",
"renderedBody": "<string>",
"consequence": "<string>"
},
"recipientMemberId": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
connectorId: '<string>',
savedCampaignVersion: '<string>',
readinessVersion: '<string>',
idempotencyKey: '<string>',
confirmation: {
token: '<string>',
connectorId: '<string>',
recipientMemberId: '<string>',
renderedSubject: '<string>',
renderedBody: '<string>',
consequence: '<string>'
},
recipientMemberId: '<string>'
})
};
fetch('https://sandbox.api.app.firstsales.io/api/v1/organizations/{orgId}/workspaces/{wsId}/campaigns/{campaignId}/test-email', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": {}
}
}Campaigns
PublicApiSendCampaignTestEmail
POST /api/v1/organizations//workspaces//campaigns//test-email
POST
/
api
/
v1
/
organizations
/
{orgId}
/
workspaces
/
{wsId}
/
campaigns
/
{campaignId}
/
test-email
PublicApiSendCampaignTestEmail
curl --request POST \
--url https://sandbox.api.app.firstsales.io/api/v1/organizations/{orgId}/workspaces/{wsId}/campaigns/{campaignId}/test-email \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"connectorId": "<string>",
"savedCampaignVersion": "<string>",
"readinessVersion": "<string>",
"idempotencyKey": "<string>",
"confirmation": {
"token": "<string>",
"connectorId": "<string>",
"recipientMemberId": "<string>",
"renderedSubject": "<string>",
"renderedBody": "<string>",
"consequence": "<string>"
},
"recipientMemberId": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
connectorId: '<string>',
savedCampaignVersion: '<string>',
readinessVersion: '<string>',
idempotencyKey: '<string>',
confirmation: {
token: '<string>',
connectorId: '<string>',
recipientMemberId: '<string>',
renderedSubject: '<string>',
renderedBody: '<string>',
consequence: '<string>'
},
recipientMemberId: '<string>'
})
};
fetch('https://sandbox.api.app.firstsales.io/api/v1/organizations/{orgId}/workspaces/{wsId}/campaigns/{campaignId}/test-email', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{}{
"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-*).
Body
application/json
Response
Successful response
The response is of type object.