Get new batch information

  • Published on May 7, 2025
  • 1 minute(s) read
Prev Next
Post
/phraseex/bandit/campaigns/{campaign_id}/batch-trigger

Get new batch instructions including proportions for a campaign

Security
HTTP
Type bearer

User or account level token in Header, key = 'Authorization', value = 'Bearer '

Path parameters
campaign_id
stringRequired

Campaign Id

Body parameters

Phrasee X batch request

object
campaign_id
string Required

The Phrasee campaign ID

Example59807ed854b8891947e04303
Responses
200

Bandit trigger results successfully submitted

Expand All
object
batch_size
integer

If it is time for a new batch to be sent this will be greater than 0

Example100
batch_id
string
ExampleG56U7821fr9
batch_proportions
Array of object
object
language_variant_id
string
Example59807ed854b8891947e04303
text
string
ExampleCheck out these latest offers!
number_of_recipients
integer
Example1024