latestOpenAPI 3.0.02026-08-232861531.0 MB
d3c75c2a2f1d
campaigns
List campaigns
get/campaigns
Query parameters
ref'patient' | 'facility' | 'user'
The type of resource linked to this campaign
refIdstring
The ID of the resource linked to this campaign
namestring
The name of this campaign
channelsstring[]
The opt-in preferences and order of channels to contact the resource linked to this campaign
activeboolean
Indicates whether this campaign should be used when sending messages for this resource
lastUpdatedBy'patient' | 'integrator'
Indicates the last resource that updated this campaign
useRootAsFallbackboolean
If the patient has missing Campaigns for certain types, it will fallback to returning the root campaigns. Requires one and single patient _id
Response
List of campaigns