createConfig

Prev Next

Available in Classic and VPC

Create a settings item for each email delivery project. Currently, you can only set the feature to block delivery.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method URI
POST /config

Request headers

For headers common to Cloud Outbound Mailer APIs, see Cloud Outbound Mailer request headers.

Request body

The following describes the request body.

Field Type Required Description
type String Required Settings item to create or change
  • SEND_BLOCK_TIME: set delivery block
subType String Optional Sub type of the setting
  • Enter null for SEND_BLOCK_TIME
value String Required Settings value to create or change
  • Value is determined based on type, subType, and unit
  • SEND_BLOCK_TIME can only be an integer string, set to 7 days or 168 hours or more
unit String Required Unit of the settings value
  • DAY | HOUR

Request example

The following is a sample request.

curl --location --request POST 'https://mail.apigw.ntruss.com/api/v1/config'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
--header 'Content-Type: application/json'
--data '{
  "type": "SEND_BLOCK_TIME",
  "value": "180",
  "unit" : "HOUR"
}'

Response

The following describes the response format.

Response body

The following describes the response body.

Field Type Required Description
type String Required Settings item created or changed
subType Integer Optional Sub type of the setting
value String Required Reflected settings value

Response status codes

The following describes the response status codes.

HTTP status code Code Description
200 - Request succeeded
400 - Authentication failed, invalid request
400 77101 Error in login information
400 77102 Request error
400 77103 Requested resource does not exist
403 77201 No permissions to the requested resource
403 77202 Call from a user who hasn't subscribed to the email service
405 77001 Unsupported method type
415 77002 Unsupported media type
500 - Server error
500 77301 Default project does not exist
500 77302 External system API integration error
500 77303 Other internal server error

Response example

The following is a sample response.

{
  "type": "SEND_BLOCK_TIME",
  "subType": null,
  "value": "180"
}