Skip to main content
PATCH
/
campaigns
/
{uuid}
Update a campaign
curl --request PATCH \
  --url https://api.journeybee.io/v1/campaigns/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "type": "<string>",
  "description": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "scheduled_at": "<string>",
  "timezone": "<string>",
  "venue": "<string>",
  "physical_address": "<string>",
  "status": "<string>",
  "completed": true,
  "lead_sharing_enabled": true,
  "partner_type_referral": true,
  "partner_type_reseller": true,
  "partner_type_distributor": true,
  "enabled_modules": [],
  "email_template_uuid": "<string>"
}
'
{
  "uuid": "<string>",
  "title": "<string>",
  "type": "<string>",
  "description": "<string>",
  "status": "<string>",
  "completed": true,
  "lead_sharing_enabled": true,
  "start_date": "<string>",
  "end_date": "<string>",
  "scheduled_at": "<string>",
  "timezone": "<string>",
  "venue": "<string>",
  "physical_address": "<string>",
  "partner_type_referral": true,
  "partner_type_reseller": true,
  "partner_type_distributor": true,
  "enabled_modules": [],
  "email_template": {
    "uuid": "<string>",
    "name": "<string>",
    "subject": "<string>"
  },
  "tags": [
    {
      "uuid": "<string>",
      "label": "<string>"
    }
  ],
  "created_at": "<string>",
  "updated_at": "<string>",
  "tiers": [
    {
      "uuid": "<string>",
      "label": "<string>"
    }
  ],
  "categories": [
    {
      "uuid": "<string>",
      "label": "<string>"
    }
  ],
  "stages": [
    {
      "uuid": "<string>",
      "label": "<string>"
    }
  ],
  "partners": [
    {
      "uuid": "<string>",
      "name": "<string>",
      "shared": true,
      "shared_leads": true
    }
  ]
}

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Path Parameters

uuid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
title
string | null
type
string | null
description
string | null
start_date
string | null
end_date
string | null
scheduled_at
string | null
timezone
string | null
venue
string | null
physical_address
string | null
status
string
completed
boolean
lead_sharing_enabled
boolean
partner_type_referral
boolean
partner_type_reseller
boolean
partner_type_distributor
boolean
enabled_modules
enum<string>[]
Available options:
details,
schedule,
partners,
audience,
recipients,
email,
templates,
forms,
tags,
notes,
leads,
analytics,
assets,
mdf,
social,
settings
email_template_uuid
string | null

Response

200 - application/json

Default Response

uuid
string
required
title
string | null
required
type
string | null
required
description
string | null
required
status
string
required
completed
boolean
required
lead_sharing_enabled
boolean
required
start_date
string | null
required
end_date
string | null
required
scheduled_at
string | null
required
timezone
string | null
required
venue
string | null
required
physical_address
string | null
required
partner_type_referral
boolean
required
partner_type_reseller
boolean
required
partner_type_distributor
boolean
required
email_status
enum<string> | null
required
Available options:
draft,
scheduled,
sending,
sent,
partial,
failed,
cancelled
enabled_modules
enum<string>[]
required
Available options:
details,
schedule,
partners,
audience,
recipients,
email,
templates,
forms,
tags,
notes,
leads,
analytics,
assets,
mdf,
social,
settings
email_template
object
required
tags
object[]
required
created_at
string
required
updated_at
string
required
tiers
object[]
required
categories
object[]
required
stages
object[]
required
partners
object[]
required