Deregister Campaign

Use this endpoint when a user decides to stop campaign optimization through the ‘Optimize For Me’ service. Once deregistered, the system will no longer perform audience or creative optimizations for that campaign.This allows users full control over which campaigns are being optimized and ensures flexibility if strategies or requirements change.

POST /optimize_me/deregister_campaign

Deregister Campaign

cURL

curl --request POST \
  --url https://public.plai.io/optimize_me/deregister_campaign \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "userId": "<string>",
  "campaignId": "<string>"
}
'

200

{
  "success": true,
  "results": {
    "success": true,
    "error": "<string>"
  }
}

Request Body

userId · string · required

User ID, If not already created, make a user on create user page first. If already created, retrieve the user ID from get profile page.

campaignId · string · required

Campaign ID

Response

success · boolean

Indicates that the HTTP response was successful (status code 200 OK).

results · object

Show Results Object

success · boolean

Indicates whether the specific operation or API action was successful.

error · string

Error string if something went wrong