Update campaign

Partially updates a campaign. Omit fields to leave them unchanged; pass null for objective or goal to clear them.

patch

Authorizations

AuthorizationstringRequired

All requests require Authorization: Bearer sl_live_<your_api_key>. Generate a key from the Shoplift admin's API Keys settings page.

Path parameters

idstring · uuidRequired

Body

namestring · nullableOptional

objectivestring · nullableOptional

goalstring · nullableOptional

Responses

200

OK

application/json

400

Bad Request

application/problem+json

typestring · nullableOptional

titlestring · nullableOptional

statusinteger · nullableOptional

detailstring · nullableOptional

instancestring · nullableOptional

403

Forbidden

application/problem+json

404

Not Found

application/problem+json

409

Conflict

application/problem+json

429

Too Many Requests

application/problem+json

patch/api/public/v1/campaigns/{id}

PATCH /api/public/v1/campaigns/{id} HTTP/1.1
Host: app.shoplift.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "name": null,
  "objective": null,
  "goal": null
}

{
  "type": null,
  "title": null,
  "status": null,
  "detail": null,
  "instance": null
}