Set campaign status | Atlas

Enable or disable a campaign

api-keystring

Your Atlas API key. Get it from the Atlas Portal under Settings > API Keys.

idstringRequired

This endpoint expects an object.

enabledbooleanRequired

Status updated

odata.etagstring

PartitionKeystring

RowKeystring

Timestampdatetime

Namestring

Descriptionstring

Genderstring

Languagestring

Providerstring

ProviderIDstring

PreviewUrlstringformat: "uri"

ProviderSettingsstring

JSON-encoded string, e.g. {“Stability”:0.5,“SimilarityBoost”:0.75,“Model”:“eleven_monolingual_v1”}

404

Not Found Error

500

Internal Server Error

$	curl -X PUT https://api.youratlas.com/v1/api/campaign/id/status \
>	-H "api-key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"enabled": true
>	}'

1	[
2	{
3	"odata.etag": "W/\"datetime'2024-01-15T09%3A30%3A00.0000000Z'\"",
4	"PartitionKey": "VoicePartition",
5	"RowKey": "voice12345",
6	"Timestamp": "2024-01-15T09:30:00Z",
7	"Name": "Emma",
8	"Description": "English female voice with clear articulation",
9	"Gender": "Female",
10	"Language": "en-US",
11	"Provider": "Azure",
12	"ProviderID": "azure-voice-001",
13	"PreviewUrl": "https://voices.youratlas.com/previews/emma.mp3",
14	"ProviderSettings": "{\"Stability\":0.7,\"SimilarityBoost\":0.8,\"Model\":\"eleven_monolingual_v1\"}"
15	}
16	]