> ## Documentation Index > Fetch the complete documentation index at: https://docs.extole.com/llms.txt > Use this file to discover all available pages before exploring further. # Update campaigns by program label > Applies the specified update to all campaigns associated with the given program label. Fields omitted from the body are left unchanged, except `program_type`, which the request schema marks required and which every request must send. ## OpenAPI ````yaml /api-reference/management.json put /v2/campaigns/program/{program_label}/update openapi: 3.0.1 info: description: >- Configuration endpoints for the Extole platform: campaigns, components, audiences, persons, rewards, reporting, integrations setup, and administrative tooling. ## Updating a resource `PUT` merges. A field you omit from the body is left at its stored value, so you do not need to read a resource and send it back whole in order to change one field. This is a deliberate departure from the HTTP convention that `PUT` replaces, and it holds across this API. Two qualifications, both visible on each operation's own request schema: - Some operations mark fields `required` in their request schema. Those must be sent on every request, whether or not you are changing them. - A field that holds a list or a map is replaced, not merged, when you supply it. Sending one entry of a collection stores that entry and drops the rest, so to change one member of a collection you must send the collection's other members alongside it. title: Management API version: '1.0' servers: - description: Production url: https://api.extole.io security: - HEADER: [] - QUERY: [] - COOKIE: [] tags: - name: Audiences - name: Authentication - name: Batch Jobs - name: Batch Jobs (Legacy) - name: Blocks - name: Campaigns - name: Components - name: Components Operations - name: Domains - name: Email - name: Erasure - name: Event Streams - name: Optout - name: Profiles - name: Promotion Links - name: Report Schedules - name: Report Types - name: Reports - name: Reward Suppliers - name: SFTP Servers - name: Security Keys - name: Settings - name: User Notifications - name: User Subscriptions - name: Users - name: Webhooks paths: /v2/campaigns/program/{program_label}/update: put: tags: - Campaigns summary: Update campaigns by program label description: >- Applies the specified update to all campaigns associated with the given program label. Fields omitted from the body are left unchanged, except `program_type`, which the request schema marks required and which every request must send. parameters: - in: path name: program_label required: true schema: type: string requestBody: content: application/json: example: program_type: program_type schema: $ref: '#/components/schemas/CampaignProgramUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/SuccessResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' campaign_build_failed: $ref: '#/components/examples/campaign_build_failed' campaign_concurrent_client_change_update: $ref: >- #/components/examples/campaign_concurrent_client_change_update campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' campaign_description_out_of_range: $ref: '#/components/examples/campaign_description_out_of_range' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' campaign_invalid_tag: $ref: '#/components/examples/campaign_invalid_tag' campaign_locked: $ref: '#/components/examples/campaign_locked' campaign_name_already_used: $ref: '#/components/examples/campaign_name_already_used' campaign_name_illegal_character: $ref: '#/components/examples/campaign_name_illegal_character' campaign_name_is_missing: $ref: '#/components/examples/campaign_name_is_missing' campaign_name_out_of_range: $ref: '#/components/examples/campaign_name_out_of_range' campaign_stale_version: $ref: '#/components/examples/campaign_stale_version' campaign_tags_too_long: $ref: '#/components/examples/campaign_tags_too_long' campaign_version_malformed: $ref: '#/components/examples/campaign_version_malformed' component_operation_parameter_invalid: $ref: '#/components/examples/component_operation_parameter_invalid' component_operation_path_malformed: $ref: '#/components/examples/component_operation_path_malformed' component_operation_path_missing: $ref: '#/components/examples/component_operation_path_missing' component_operation_schema_invalid: $ref: '#/components/examples/component_operation_schema_invalid' component_operation_schema_too_large: $ref: '#/components/examples/component_operation_schema_too_large' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' date_invalid: $ref: '#/components/examples/date_invalid' duplicate_step_data_name: $ref: '#/components/examples/duplicate_step_data_name' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' invalid_campaign_id: $ref: '#/components/examples/invalid_campaign_id' invalid_campaign_state: $ref: '#/components/examples/invalid_campaign_state' invalid_campaign_version: $ref: '#/components/examples/invalid_campaign_version' invalid_incoming_url: $ref: '#/components/examples/invalid_incoming_url' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' invalid_program_type: $ref: '#/components/examples/invalid_program_type' invalid_theme_name: $ref: '#/components/examples/invalid_theme_name' invalid_uri_in_json: $ref: '#/components/examples/invalid_uri_in_json' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' missing_step_data_name: $ref: '#/components/examples/missing_step_data_name' missing_step_data_value: $ref: '#/components/examples/missing_step_data_value' program_type_empty: $ref: '#/components/examples/program_type_empty' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' step_data_default_value_expression_length_out_of_range: $ref: >- #/components/examples/step_data_default_value_expression_length_out_of_range step_data_name_length_out_of_range: $ref: '#/components/examples/step_data_name_length_out_of_range' step_data_value_expression_length_out_of_range: $ref: >- #/components/examples/step_data_value_expression_length_out_of_range unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests components: schemas: CampaignProgramUpdateRequest: description: Body of a `PUT /v2/campaigns/program/{program_label}/update` request. properties: program_type: type: string required: - program_type type: object SuccessResponse: properties: status: type: string required: - status type: object RestExceptionResponse: description: Represents the API error response properties: code: description: Specific error code for this error type, documented per endpoint type: string http_status_code: description: >- HTTP status code that was returned with this error, useful if client get response code format: int32 type: integer message: description: User readable English description of the error type: string parameters: additionalProperties: description: >- Attributes related to the error, varies be error code, documented per endpoint type: object description: >- Attributes related to the error, varies be error code, documented per endpoint type: object unique_id: description: >- Unique id associated with this error, useful for discussions with Extole type: string required: - code - http_status_code - message - parameters - unique_id type: object examples: binding_error: summary: binding_error value: code: binding_error http_status_code: 400 message: Argument is not of the expected type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_build_failed: summary: campaign_build_failed value: code: campaign_build_failed http_status_code: 400 message: Campaign build failed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_concurrent_client_change_update: summary: campaign_concurrent_client_change_update value: code: campaign_concurrent_client_change_update http_status_code: 400 message: >- Could not perform the operation. A client wide configuration change is rebuilding this campaign. Retry once it completes parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_concurrent_update: summary: campaign_concurrent_update value: code: campaign_concurrent_update http_status_code: 400 message: >- Could not perform the operation. Campaign is currently updated by other process/user parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_description_out_of_range: summary: campaign_description_out_of_range value: code: campaign_description_out_of_range http_status_code: 400 message: Campaign description length must be between 2 and 250 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_has_pending_changes: summary: campaign_has_pending_changes value: code: campaign_has_pending_changes http_status_code: 400 message: Could not perform the operation. Campaign has pending changes parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_invalid_tag: summary: campaign_invalid_tag value: code: campaign_invalid_tag http_status_code: 400 message: A tag contains invalid characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_locked: summary: campaign_locked value: code: campaign_locked http_status_code: 400 message: Could not perform the operation. The campaign is locked parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_name_already_used: summary: campaign_name_already_used value: code: campaign_name_already_used http_status_code: 400 message: Campaign name is already used by another campaign parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_name_illegal_character: summary: campaign_name_illegal_character value: code: campaign_name_illegal_character http_status_code: 400 message: >- Campaign name can only contain alphanumeric, space, dash, parenthesis, slash, colon, comma, period, underscore, dollar and percentage parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_name_is_missing: summary: campaign_name_is_missing value: code: campaign_name_is_missing http_status_code: 400 message: Campaign name is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_name_out_of_range: summary: campaign_name_out_of_range value: code: campaign_name_out_of_range http_status_code: 400 message: Campaign name length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_stale_version: summary: campaign_stale_version value: code: campaign_stale_version http_status_code: 400 message: You can only modify the latest version of the campaign parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_tags_too_long: summary: campaign_tags_too_long value: code: campaign_tags_too_long http_status_code: 400 message: Tags length is too long parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_version_malformed: summary: campaign_version_malformed value: code: campaign_version_malformed http_status_code: 400 message: Campaign version is malformed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_operation_parameter_invalid: summary: component_operation_parameter_invalid value: code: component_operation_parameter_invalid http_status_code: 400 message: Component operation parameter is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_operation_path_malformed: summary: component_operation_path_malformed value: code: component_operation_path_malformed http_status_code: 400 message: Component operation path is malformed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_operation_path_missing: summary: component_operation_path_missing value: code: component_operation_path_missing http_status_code: 400 message: Component operation path is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_operation_schema_invalid: summary: component_operation_schema_invalid value: code: component_operation_schema_invalid http_status_code: 400 message: >- Component operation schema is not a valid JSON Schema draft 2020-12 document parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_operation_schema_too_large: summary: component_operation_schema_too_large value: code: component_operation_schema_too_large http_status_code: 400 message: Component operation schema serialized length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 controller_state_misconfiguration: summary: controller_state_misconfiguration value: code: controller_state_misconfiguration http_status_code: 400 message: A controller has not properly configured state parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 date_invalid: summary: date_invalid value: code: date_invalid http_status_code: 400 message: Date is invalid or not ISO-8601 compliant parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 duplicate_step_data_name: summary: duplicate_step_data_name value: code: duplicate_step_data_name http_status_code: 400 message: Step data name is duplicated parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 expression_invalid_syntax: summary: expression_invalid_syntax value: code: expression_invalid_syntax http_status_code: 400 message: Campaign build failed due expression invalid syntax parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_campaign_id: summary: invalid_campaign_id value: code: invalid_campaign_id http_status_code: 400 message: Invalid Campaign Id parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_campaign_state: summary: invalid_campaign_state value: code: invalid_campaign_state http_status_code: 400 message: Invalid campaign state parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_campaign_version: summary: invalid_campaign_version value: code: invalid_campaign_version http_status_code: 400 message: Invalid Campaign Version parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_incoming_url: summary: invalid_incoming_url value: code: invalid_incoming_url http_status_code: 400 message: Incoming URL is an invalid URI parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_json: summary: invalid_json value: code: invalid_json http_status_code: 400 message: JSON is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_parameter: summary: invalid_parameter value: code: invalid_parameter http_status_code: 400 message: Parameter is invalid. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_program_type: summary: invalid_program_type value: code: invalid_program_type http_status_code: 400 message: Invalid program type, length must be between 1 and 128 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_theme_name: summary: invalid_theme_name value: code: invalid_theme_name http_status_code: 400 message: Invalid theme_name, length must be between 1 and 255 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_uri_in_json: summary: invalid_uri_in_json value: code: invalid_uri_in_json http_status_code: 400 message: Invalid URI in JSON parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 lock_missing_lock_types: summary: lock_missing_lock_types value: code: lock_missing_lock_types http_status_code: 400 message: Unable to unlock, lock types should be specified parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_request_body: summary: missing_request_body value: code: missing_request_body http_status_code: 400 message: Missing request body parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_step_data_name: summary: missing_step_data_name value: code: missing_step_data_name http_status_code: 400 message: Missing step data name parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_step_data_value: summary: missing_step_data_value value: code: missing_step_data_value http_status_code: 400 message: Missing step data value parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 program_type_empty: summary: program_type_empty value: code: program_type_empty http_status_code: 400 message: Program type cannot be empty or null parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 rebuild_campaigns_build_failed: summary: rebuild_campaigns_build_failed value: code: rebuild_campaigns_build_failed http_status_code: 400 message: Rebuild campaigns build failed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 step_data_default_value_expression_length_out_of_range: summary: step_data_default_value_expression_length_out_of_range value: code: step_data_default_value_expression_length_out_of_range http_status_code: 400 message: >- Step data default value expression length is out of range. Max 2000 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 step_data_name_length_out_of_range: summary: step_data_name_length_out_of_range value: code: step_data_name_length_out_of_range http_status_code: 400 message: Step data name length is out of range. Max 255 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 step_data_value_expression_length_out_of_range: summary: step_data_value_expression_length_out_of_range value: code: step_data_value_expression_length_out_of_range http_status_code: 400 message: Step data value expression length is out of range. Max 2000 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unlock_missing_lock_types: summary: unlock_missing_lock_types value: code: unlock_missing_lock_types http_status_code: 400 message: Unable to lock, lock types should be specified parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 method_unauthorized: summary: method_unauthorized value: code: method_unauthorized http_status_code: 401 message: Unauthorized access to this endpoint parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 payment_required: summary: payment_required value: code: payment_required http_status_code: 402 message: The access_token provided is associated with an unpaid account. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 access_denied: summary: access_denied value: code: access_denied http_status_code: 403 message: >- The access_token provided is not permitted to access the specified resource. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_access_token: summary: missing_access_token value: code: missing_access_token http_status_code: 403 message: No access_token was provided with this request. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unsupported_media_type: summary: unsupported_media_type value: code: unsupported_media_type http_status_code: 415 message: Request had an unsupported or no media type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 too_many_requests: summary: too_many_requests value: code: too_many_requests http_status_code: 429 message: >- The server is unable to process your request at the moment, please retry later. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 securitySchemes: HEADER: in: header name: Authorization type: apiKey x-bearer-format: bearer QUERY: in: query name: access_token type: apiKey COOKIE: in: cookie name: extole_token type: apiKey ```` ## Related topics - [Rename a campaigns program label](/api-reference/campaigns/rename-a-campaigns-program-label.md) - [How to Target a Program](/guides/flow-campaigns/how-to-target-a-program.md) - [Change the Reward on your Program](/guides/flow-campaigns/change-the-reward-on-your-program.md) - [Update a component operation](/api-reference/components-operations/update-a-component-operation.md) - [Making Updates to your Campaigns](/guides/programs-and-campaigns/managing-campaigns/making-updates-to-your-campaigns.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.