Realtime language request

  • Published on May 7, 2025
  • 1 minute(s) read
Prev Next
Get
/live/single_variant

Request a language variant by subscriber. NOTE: this endpoint uses the Realtime API base URL (https://realtime.phrasee.co) rather than the standard base URL

Security
HTTP
Type bearer

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

Query parameters
campaign_id
stringRequired

Campaign ID for the current send

Responses
200

language variant has successfully been created and returned

object
variant_text
string

the variant content, created by Phrasee

ExampleDon't let this one slip away
variant_id
string

the internal Phrasee variant ID, this is needed if aggregated results are returned to Phrasee

Example5d6ede6a0ba62570afcedd3a
campaign_id
string

the internal Phrasee campaign ID, this is needed if aggregated results are returned to Phrasee

Example59807ed854b8891947e04303
project_id
string

the internal Phrasee project ID

Example86ffe42a3549080abc908249
batch_id
integer

the ID number of the 'batch' that this send belongs to, this is useful when returning results to Phrasee

Example10
send_id
string

an anonymized unique identifier for this request, this is important to keep track of to ensure uniqueness in results

Example24c23c41-121c-413c-aa86-8ddaa254bb70
statistics_url
string

a URL that refers to Phrasee's open tracking pixel, this URL is designed to be used as-is in an email body, or other link

Examplehttps://mail-tracking.phrasee.co/dev/open?variant_id=5d6ede6a0ba62570afcedd3a&campaign_id=59807ed854b8891947e04303&batch_id=10&project_id=86ffe42a3549080abc908249&send_id=24c23c41-121c-413c-aa86-8ddaa254bb70
401

Invalid token

403

Supplied token invalid for specified campaign

404

Campaign could not be found

500

Unspecified server side error