Start a Promo campaign
start_campaignStart a campaign for an upcoming or released release, or the posts between releases. Audora plans it (every post's day, time, words and lane) for free; fill each post from the artist's Library with update_post, or, with the artist's spend permission, have Audora make the pictures and videos (make: true, priced first). A campaign is planned in moments: one video or picture posted the same day on every connected account it fits, with words for each account. Each moment costs 1 credit to go out, all its accounts included, set aside when its first post is scheduled. The answers about the song (the_story, key_lyrics, key_moments, what_works, sonic_references, note) are the Start panel's: optional, filled from what Audora knows when left out, and they turn on posts that use them. Use dry_run first to see the posts, the price and those answers (quote.answers), and tell the artist.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| make | No | Have Audora make every post's picture or video too (credits; needs the artist's spend permission). Default: plan only. | |
| note | No | Optional, ≤ 200 characters: "Anything we should know?", anything else the planner should know, in the artist's words. Left out: the last campaign's for this release, if any. | |
| size | Yes | light, steady or loud: how many posts over how many weeks. | |
| about | No | Between releases only: what the campaign is about. "song" (with about_track_id, one of the artist's songs) or "artist" (posts about who they are, their sound and their artist page; no line is kept). Left out: planned as before. | |
| lanes | Yes | Where the posts go. Only lanes with a connected account are planned. | |
| artist | No | Only when you are connected as a label: the roster artist this call is for — their artist_user_id from list_roster, or their exact artist name. Required for every artist tool on a label connection. Leave it out on an artist's own connection. | |
| dry_run | No | True to check the call and see what it would do, without writing anything. | |
| the_story | No | Optional, ≤ 5000 characters: "The story behind it", in the artist's own words. Where it was written, what happened, who it is for. Posts tell it in your words. Never write it for them. | |
| key_lyrics | No | Optional, up to 2: "A line that matters", word for word from the song's lyrics (get_track has them). A line not in the lyrics is refused; a song with no lyrics takes a line the artist types; an instrumental takes none. | |
| release_id | No | The release (from list_releases or list_campaigns' can_start). Or use between_releases. | |
| what_works | No | Optional, ≤ 2000 characters: "What worked before", in the artist's words. A post, a format or a time that did well for you. Posts can take the same shape again. | |
| key_moments | No | Optional, up to 6: "Something coming up". A show, a video, a date that matters. Posts lead up to it. Left out: Scene's public shows and parties inside the campaign's weeks. | |
| lyric_video | No | Optional, with make: the campaign's first video shows the song's words in time with the song. Audora times the lyrics when the campaign starts (free), so that video comes about 10 minutes later. false: no video shows lyrics. Left out: on when the song's lyrics can be timed. A dry run's quote.lyric_video says the song and where its lyrics stand (to_time, timing, timed, or why not: no_lyrics, instrumental, language, no_master). | |
| post_language | No | Optional: the language every post in this campaign is written in, with the text on its pictures and videos. Left out: the artist's Post language, else the language the release's songs are sung in, else en-US. A dry run's quote.post_language says which and why. It is the campaign's, never written back to the artist. | |
| about_track_id | No | With about: "song", the song the campaign is about (list_tracks). | |
| idempotency_key | No | Send the same key if you retry, and the change happens once. | |
| between_releases | No | True for the posts between releases instead of a release. | |
| picture_fallback | No | Optional: what fills the posts the artist's own photos and cover do not cover, when Audora makes them. stock: free Pixabay stock photos, always made into the artist's cards (people and brands left out; not offered for a song about drugs, sex or politics). new: Audora draws a new picture. ask: those posts wait for the artist to pick a photo in the app. Same price whichever. Left out: the artist's last answer, else stock. A dry run's quote.picture_fallback says the starting choice and whether stock may be used. | |
| sonic_references | No | Optional, up to 5 names: "Artists you sound like". Left out: the Artist page's reference artists. | |
| key_lyrics_track_id | No | The song the lines are from: one of the release's songs, or between releases any of the artist's. Left out: the release's songs are tried; between releases, the artist's newest songs with lyrics. | |
| confirm_cost_credits | No | The price a dry run quoted (charged_at_start) and you told the artist. Required with make, or when the plan itself has a price. |