Save a custom prompt onto a sender profile

Upserts the given prompt into sender_data.prompts[] (named slot, default ‘saved’) AND mirrors it to sender_data.custom_prompt atomically. Used from the preview playground when a user wants future campaigns to use their iterated prompt.

POST /api/v1/personalize/save-prompt

Save a custom prompt onto a sender profile

cURL

curl --request POST \
  --url https://api.example.com/api/v1/personalize/save-prompt \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sender_profile_id": "<string>",
  "prompt": "<string>",
  "save_as_name": "saved"
}
'

200

{}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

sender_profile_id · string · required

prompt · string · required

Required string length: 100 - 5000

save_as_name · string | null · default: saved

Named prompt slot to upsert into. Defaults to 'saved' so repeated playground saves update the same slot rather than accumulating entries. Collision with a reserved name returns 422.

Response

200

application/json

Successful Response

The response is of type Response Save Personalization Prompt Api V1 Personalize Save Prompt Post · object.