---
title: "Update Campaign"
method: PUT
path: "/api/v1.0/campaigns/{id}"
tags: ["Campaigns"]
---

# Update Campaign

`PUT /api/v1.0/campaigns/{id}`

## Path parameters

- `id` string, required

## Request body

- Campaign
  - `amount_unit` 'currency' | 'currency_gbp' | 'currency_week' | 'currency_month' | 'weight_kg' | 'weight_lbs' | 'weight_tonnes' — The unit of the 'amount' field
  - `created_at` number — The date/time the Campaign was created at represented as an integer
  - `custom_fields` object[] — List of custom fields for a campaign
    - `id` string — The ID of the Custom Field
    - `name` string — The visible name of the Custom Field in the UI
    - `description` string — Optional help text for the Custom Field (max 120 characters)
    - `type` 'text' | 'select' | 'multiselect' | 'number' | 'date' | 'datetime' | 'sic' | 'naics' | 'table' — The type of the custom field
    - `required` 'fresh' | 'received_by_sales' | 'work_in_progress' | 'pending_decision' | 'contract_signed' | 'completed' | 'failed' | 'hibernated' — The stage the Custom Field is required to be filled in by
    - `platform` 'both' | 'web' | 'integrations' — Who can see/update the Custom Field. 'both' is all Users, 'web' is Sales/Managers only, and 'integrations' is only visible in the API
    - `ui` 'all' | 'update' — Which forms the field is visible in. Use 'all' to have the field visible in both the create and edit Lead Forms. Use 'update' to show the field in the edit Lead form only
    - `section` string — The ID of the section the Custom Field will display under. If the ID does not match one of the values in lead_sections, it will display in the General Info section
    - `default` string — The default value of the Custom Field
    - `options` unknown[] — An array of values the Custom Field can be. Used and required for only select and multiselect Custom Fields
      - unknown
    - `columns` object[] — The columns of the table Custom Field. Required and used only by the table type Custom Field
      - `id` string — The ID of the Column
      - `name` string — The visible name of the Column in the UI
      - `description` string — Optional help text for the Column (max 120 characters)
      - `type` 'text' | 'select' | 'multiselect' | 'number' | 'date' | 'datetime' | 'sic' | 'naics' | 'table' — The type of the Column
  - `contact_fields` object[] — List of custom fields for contacts on a campaign
    - `id` string — The ID of the Contact Custom Field
    - `name` string — The visible name of the Contact Custom Field in the UI
    - `description` string — Optional help text for the Contact Custom Field (max 120 characters)
    - `type` 'text' | 'select' | 'multiselect' | 'number' | 'date' | 'datetime' — The type of the contact custom field
    - `default` string — The default value of the Contact Custom Field
    - `options` unknown[] — An array of values the Contact Custom Field can be. Used and required for only select and multiselect types
      - unknown
  - `name` string — The name of the campaign
  - `label_for_lead` string — The label name for the Lead object on the Campaign
  - `logo_url` string — The url to the campaign's logo

## Response `200`

Success

---

[API](https://skmtc.dev/wingmateapp/apis/wingmate-api.md) · [All operations](https://skmtc.dev/wingmateapp/apis/wingmate-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/wingmateapp/wingmate-api/revisions/d6fccce94b7c/schema)