Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateCampaignCommunicationTime

Updates CommunicationTimeConfig for an outbound campaign. Only campaigns in the Initialized state are valid for this operation.

Request Syntax


POST /v2/campaigns/id/communication-time HTTP/1.1
Content-type: application/json

{
   "communicationTimeConfig": { 
      "email": { 
         "openHours": { ... },
         "restrictedPeriods": { ... }
      },
      "localTimeZoneConfig": { 
         "defaultTimeZone": "string",
         "localTimeZoneDetection": [ "string" ]
      },
      "sms": { 
         "openHours": { ... },
         "restrictedPeriods": { ... }
      },
      "telephony": { 
         "openHours": { ... },
         "restrictedPeriods": { ... }
      }
   }
}

URI Request Parameters

The request uses the following URI parameters.

id

The identifier of the outbound campaign.

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [a-zA-Z0-9\-:/]*

Required: Yes

Request Body

The request accepts the following data in JSON format.

communicationTimeConfig

Communication time configuration for an outbound campaign. Only campaigns in the Initialized state are valid for this operation.

Type: CommunicationTimeConfig object

Required: Yes

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request could not be processed because of a conflict in the current state of the resource.

HTTP Status Code: 409

InternalServerException

This exception occurs when there is an internal failure in the outbound campaigns.

HTTP Status Code: 500

InvalidCampaignStateException

An attempt was made to modify a campaign that is in a state that is not valid. Check your campaign to ensure that it is in a valid state before retrying the operation.

HTTP Status Code: 409

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400