TCR Developer Portal
Breadcrumbs

Update a Campaign

If you need to update a campaign’s properties after it’s been created, you can do that with this endpoint.

Not all fields can be updated. Refer to the table in the PUT /campaign/{campaignId} endpoint for more information. Fields that are not submitted won’t be updated.

Request

PUT /campaign/{campaignId}

curl -X 'PUT' \
  'https://csp-api-staging.campaignregistry.com/v2/campaign/C123ABC' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "description": "Occasional promotions, motivational messages, events, news, and membership information for a community gym.",
  "sample1": "Downtown Community Health Club: Thank you for registering with us. We look forward to meeting you and getting you started on your journey! Someone will give you a call soon to answer any questions you may have and get you scheduled to start your trial! Reply STOP to opt-out or HELP for help.",
  "privacyPolicyLink": "https://communityclub.com/resources/privacy-policy/",
  "termsAndConditionsLink": "https://communityclub.com/resources/terms-conditions/"
}'

Response

{
  "campaignId": "C123ABC",
  "cspId": "S123ABC",
  "resellerId": "R000000",
  "status": "ACTIVE",
  "createDate": "2025-06-11T01:33:18.000Z",
  "autoRenewal": true,
  "billedDate": "2025-06-11T00:00:00.000Z",
  "brandId": "B123ABC",
  "vertical": null,
  "usecase": "MARKETING",
  "subUsecases": [],
  "description": "Occasional promotions, motivational messages, events, news, and membership information for a community gym.",
  "embeddedLink": true,
  "embeddedPhone": true,
  "termsAndConditions": true,
  "numberPool": false,
  "ageGated": false,
  "directLending": false,
  "subscriberOptin": true,
  "subscriberOptout": true,
  "subscriberHelp": true,
  "sample1": "Downtown Community Health Club: Thank you for registering with us. We look forward to meeting you and getting you started on your journey! Someone will give you a call soon to answer any questions you may have and get you scheduled to start your trial! Reply STOP to opt-out or HELP for help.",
  "sample2": "Community Health Club: Hey {first_name}, You’ve hit double digits with 10 classes at Community Health Club! Keep up the great work! Reply STOP to opt-out.",
  "sample3": "Hi {first_name}, thank you for being a part of Community Health Club! We would love to hear about your experience with us. Please reply with your rating, with '1' being a poor experience and '5' being an exceptional experience. Reply STOP to opt-out.",
  "sample4": null,
  "sample5": null,
  "messageFlow": "Members opt-in to SMS when they sign their agreement and leads submit their phone number online to receive more information on membership offers. Leads can sign up for a newsletter and contact the gym using this form - https://exampleforms.org",
  "helpMessage": "Community Health Club: You'll be receiving text alerts from us regarding your account, offers & more. You can contact us at (555) 555-5555. Standard data rates may apply.",
  "referenceId": null,
  "mock": false,
  "nextRenewalOrExpirationDate": "2025-09-11",
  "expirationDate": null,
  "optinKeywords": "YES,START",
  "optoutKeywords": "STOP",
  "helpKeywords": "HELP",
  "optinMessage": "Community Health Club: You've successfully opted in to our alerts. At any time, reply STOP to opt-out or HELP for help.",
  "optoutMessage": "Community Health Club: You've been successfully opted out of receiving text alerts. To re-opt in reply START.",
  "privacyPolicyLink": "https://communityclub.com/resources/privacy-policy/",
  "termsAndConditionsLink": "https://communityclub.com/resources/terms-conditions/",
  "embeddedLinkSample": ""
}