v1
latestSwagger 2.02026-08-04471124.2 KBcampaigns
patch/campaigns/{uuid}/
Request body
uuidstring uuid
Unique campaign identifier
namestring required
Campaign name
template_uuidstring uuid required
start_atstring date-time nullable
Campaign start time
end_atstring date-time nullable
Campaign end time
settingsobject
Campaign-specific settings overrides
activeboolean
type'survey' | 'tutoring'
Campaign type (e.g. Survey, Tutoring)
access_type'open' | 'invite_only'
Access control: Open (public link) or Invite Only
max_sessionsinteger nullable
Maximum number of sessions allowed (protection cap)
created_atstring date-time
Response
OK
uuidstring uuid
Unique campaign identifier
namestring required
Campaign name
template_uuidstring uuid required
start_atstring date-time nullable
Campaign start time
end_atstring date-time nullable
Campaign end time
settingsobject
Campaign-specific settings overrides
activeboolean
type'survey' | 'tutoring'
Campaign type (e.g. Survey, Tutoring)
access_type'open' | 'invite_only'
Access control: Open (public link) or Invite Only
max_sessionsinteger nullable
Maximum number of sessions allowed (protection cap)
created_atstring date-time