Partial Update Campaign

Applies a partial update to a campaign record, modifying only the fields present in the request body. All fields not included in the payload retain their existing values.

Key Benefit
More efficient than PUT when updating only specific fields — you only send what changes.

Request Body Format
All fields are optional. Include only the fields you want to update.

Common Use Cases

Pause a campaign:

{ "status": "inactive" }

Extend campaign duration:

{ "end_date": "2026-12-31T17:00:00" }

Update budget:

{ "campaign_spend": 10000, "campaign_spend_frequency": "monthly" }

Change campaign name:

{ "campaign_name": "Updated Campaign Name" }

Date/Time Handling

Dates are converted to specified timezone before storage

When updating dates without providing timezone, uses existing campaign timezone

All date formats are interpreted in the target timezone (Z and offsets are stripped)

See PUT /campaigns/:id for detailed date handling rules

Validation Rules

end_date must be >= start_date

Cannot set ACTIVE status with past end date/time

If updated start_date time is in the future AND status is ACTIVE → automatically set to INACTIVE

Use status: "inactive" to update campaigns with past end dates

Business Constraints

At least one field must be present in the request

Campaign must not be in deleted status

If campaign_name is changed, it must remain unique within organization

User must have access to the campaign's org_unit_id

Updatable Fields
campaign_name, status, start_date, end_date, timezone, owner_user_id, external_id, campaign_spend, conversion_value, campaign_spend_frequency, referral_pnumber

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location --globoff --request PATCH 'https://platform-api.convirza.com/v3/campaigns/{id}' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "campaign_name": "Fall Sale 2026", "campaign_ext_id": 12345, "status": "active", "start_date": "2026-06-01T09:00:00", "end_date": "2026-08-31T17:00:00", "timezone": "America/New_York", "owner_user_id": 101, "campaign_spend": 5000, "conversion_value": 150, "campaign_spend_frequency": "one-time", "referral_pnumber": "1234567890" }'

{ "code": 200, "message": "Success", "data": { "message": "Campaign updated successfully", "campaign_id": 1 }, "request_id": "550e8400-e29b-41d4-a716-446655440000", "timestamp": "2026-01-20T12:34:56.789Z" }

Partial Update Campaign

Request

Responses