latestOpenAPI 3.0.02026-08-232861531.0 MB

d3c75c2a2f1d

campaigns

Update a campaign

put/campaigns/{campaignId}

Path parameters

campaignIdstring required

Request body

_idstring

Luma's internal ID of an object.

userstring

The ID of the root account user.

deleted0 | 1

Flag for logical deletion where 1 means deleted.

createdBystring

The ID of the user who created this object.

updatedBystring

The ID of the user who updated this object.

createdAtstring date-time

The date/time when this object was created.

updatedAtstring date-time

The date/time when this object was updated.

ref'patient' | 'facility' | 'user'
refIdstring
namestring
channelsstring[]
type'inbound' | 'outbound'
lastUpdatedBy'patient' | 'integrator'
{"stackTrail":"components:schemas:Campaign:properties:active","oasType":"schema","type":"unknown"}

Response

Campaign updated

_idstring

Luma's internal ID of an object.

userstring

The ID of the root account user.

deleted0 | 1

Flag for logical deletion where 1 means deleted.

createdBystring

The ID of the user who created this object.

updatedBystring

The ID of the user who updated this object.

createdAtstring date-time

The date/time when this object was created.

updatedAtstring date-time

The date/time when this object was updated.

ref'patient' | 'facility' | 'user'
refIdstring
namestring
channelsstring[]
type'inbound' | 'outbound'
lastUpdatedBy'patient' | 'integrator'
{"stackTrail":"components:schemas:Campaign:properties:active","oasType":"schema","type":"unknown"}