Set campaign status | Atlas

[
  {
    "odata.etag": "W/\"datetime'2024-01-15T09%3A30%3A00.0000000Z'\"",
    "PartitionKey": "VoiceCatalog",
    "RowKey": "voice12345",
    "Timestamp": "2024-01-15T09:30:00Z",
    "Name": "Emma",
    "Description": "English female voice with clear articulation",
    "Gender": "Female",
    "Language": "en-US",
    "Provider": "Azure",
    "ProviderID": "azure-voice-001",
    "PreviewUrl": "https://audio-previews.youratlas.com/voices/azure-voice-001.mp3",
    "ProviderSettings": "{\"Stability\":0.7,\"SimilarityBoost\":0.8,\"Model\":\"eleven_monolingual_v1\"}"
  }
]

Enable or disable a campaign

Authentication

api-keystring

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

Path parameters

idstringRequired

Request

This endpoint expects an object.

enabledbooleanRequired

Response

Status updated

odata.etagstringOptional

PartitionKeystringOptional

RowKeystringOptional

TimestampdatetimeOptional

NamestringOptional

DescriptionstringOptional

GenderstringOptional

LanguagestringOptional

ProviderstringOptional

ProviderIDstringOptional

PreviewUrlstringOptionalformat: "uri"

ProviderSettingsstringOptional

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

Errors

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
>	}'