Save Conversion

Prev Next
Post
/{environment}/conversion
Path parameters
environment
stringRequired
Query parameters
variant_id
string

The Phrasee variant id

Example62a3476a675498afdd0b312a
campaign_id
string

The Phrasee experiment / campaign id

Example62a3479f8fcd86d5704b546d
account_id
string

The Phrasee account id

Example62a34835f1cba8d71359cb0b
batch_id
integer

The Phrasee batch id, if using Dynamic Optimization

Example10002
project_id
string

The Phrasee project id

Example62a34d79d87a17b87f74bb10
delivery_id
integer

The id for the message delivery, usually provided by your ESP

Example742322
recipient_id
integer

The id of the recipient receiving the delivery, usually provided by your ESP

Example9283672739
send_id
string

The unique ID identifying this specific send to a recipient

Example673457-11235-34235-23523
Body parameters
object
Example{ "variant_id": "62a3476a675498afdd0b312a", "campaign_id": "62a3479f8fcd86d5704b546d", "account_id": "62a34835f1cba8d71359cb0b", "batch_id": "10002", "project_id": "62a34d79d87a17b87f74bb10", "delivery_id": "742322", "recipient_id": "9283672739", "send_id": "673457-11235-34235-23523" }
Responses
200

OK

Headers
Content-Type
string
Exampleimage/gif
example-0

Save Conversion Success - No Body

null
example-1

Save Conversion Success - With Body

null
string