Update an opt-in process

1 min

POST

https://api.campaign.episerver.net/rest/{clientId}/optinprocesses/{optinProcessId}

Update information of an opt-in process, such as name, description or type.

Path Parameters

clientIdstringrequired
Description
Client ID
optinProcessIdinteger<int64>required
Description
Opt-in process ID
Format
int64

Header Parameters

acceptstring
Description
Generated from available response content types
Default
application/json
Allowed
application/jsonapplication/vnd.optivo.broadmail.v1+json

Form Parameters

confirmationMailingIdinteger<int64>
Description
ID of the mailing that is used for the opt-in process (only opt-in processes of type "confirmed" or "double")
Format
int64
confirmationUrlstring
Description
URL of the confirmation page to which the recipient is directed to complete the registration process (only opt-in processes of type "double")
namestringrequired
Description
Internal name of the opt-in process
typestring<single | confirmed | double>required
Description
Type of the opt-in process
Allowed
singleconfirmeddouble
descriptionstring
Description
Internal description of the opt-in process

Responses

200

The opt-in process was updated successfully.

RestOptinProcess
- idinteger<int64>
  Description
  ID of the opt-in process
  Format
  int64
- namestring
  Description
  Name of the opt-in process
- descriptionstring
  Description
  Description of the opt-in process
- typestring
  Description
  Type of the opt-in process
- confirmationMailingIdinteger<int64>
  Description
  ID of the mailing that sends the confirmation email (only opt-in processes of the type "double" or "confirmed")
  Format
  int64
- confirmationUrlstring
  Description
  Confirmation URL of the opt-in process (only opt-in processes of the type "double")
- createdstring<date-time>
  Description
  Creation date
  Format
  date-time
- modifiedstring<date-time>
  Description
  Modification date
  Format
  date-time
- linksobject[]
  Description
  Restful links
  - uriBuilderobject
  - relsstring[]
  - relstring
  - typestring
  - paramsmap<string, string>
  - titlestring
  - uristring<uri>
    Format
    uri

curl

curl --request POST \
     --url https://api.campaign.episerver.net/rest/{clientId}/optinprocesses/{optinProcessId} \
     --header 'accept: application/json' \
     --header 'content-type: application/x-www-form-urlencoded' \
     --data 'name=string' \
     --data 'type=single'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/x-www-form-urlencoded");

var urlencoded = new URLSearchParams();
urlencoded.append("name", "string");
urlencoded.append("type", "single");

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: urlencoded,
   redirect: 'follow'
};

fetch("https://api.campaign.episerver.net/rest/{clientId}/optinprocesses/{optinProcessId}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "net/http"

url = URI("https://api.campaign.episerver.net/rest/{clientId}/optinprocesses/{optinProcessId}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/x-www-form-urlencoded"
request.body = "name=string&type=single"

response = https.request(request)
puts response.read_body

python

import requests

url = "https://api.campaign.episerver.net/rest/{clientId}/optinprocesses/{optinProcessId}"

payload = 'name=string&type=single'
headers = {
   'accept': 'application/json',
   'content-type': 'application/x-www-form-urlencoded'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// The opt-in process was updated successfully.
{
  "id": "",
  "name": "",
  "description": "",
  "type": "",
  "confirmationMailingId": "",
  "confirmationUrl": "",
  "created": "",
  "modified": "",
  "links": [
    {
      "uriBuilder": {},
      "rels": [
        ""
      ],
      "rel": "",
      "type": "",
      "params": "",
      "title": "",
      "uri": ""
    }
  ]
}