Browse the API reference

Campaigns

Update a campaign

View as Markdown
patchhttps://www.getrevox.com/api/campaigns/{id}

Update a campaign's name, outbound number, retry configuration (calling hours, retry delay, max attempts) and concurrency cap. Changes are applied to the campaign's calls that have not completed yet. The assistant is fixed at creation; add contacts with POST /campaigns/:id/rows, and choose when calls go out with POST /campaigns/:id/launch-calls.

Path parameters

  • idstringrequired

Request body

  • namestring

    Campaign display name

    min length 1 · max length 255

  • from_phone_numberstringnullable

    The phone number to use for outbound calls. Editable after launch; applied to the campaign's calls that have not completed yet.

  • max_concurrent_callsnumbernullable

    Maximum concurrent calls. Editable after launch.

    min 1

  • call_retry_configCallRetryConfignullable

    Override retry configuration (calling hours, retry delay, max attempts). Editable after launch; applied to the campaign's calls that have not completed yet, whose next attempt is re-scheduled under the new configuration. Its max_retry_attempts is only the default for max_attempts in POST /campaigns/:id/launch-calls.

Responses

200Success
400Invalid request: the body or a parameter failed validation
  • messagestring
  • errorstring
  • bodyErrorsobject

    The validation errors returned from the API.

    Show 1 field
    • issuesarray of objectrequired
      Show 3 fields
      • patharray of one ofrequired
        Show 2 variants

        1. One ofstringstring

        2. One ofnumbernumber

      • messagestringrequired
      • codestring
404Not found in your organization
  • errorstringrequired