Update Object

1 min

POST

https://api.us1.odp.optimizely.com/v3/objects/{object_name}

Update an object (for example, Concert Tickets or Reviews). Use the Objects endpoint to update the top-level order summary fields without generating events.

Path Parameters

object_namestringrequired
Description
name of the object

Body Parameters

bodyObject[]required

Examples

Example Payload:

[
  {
    "primary_key": 123,
    "field_example": true
  },
  {
    "primary_key": 456,
    "field_example": false
  }
]

Responses

202Accepted

GenericUpdateResponse
- titlestring
- statusinteger<int32>
  Format
  int32
- timestampstring

400Bad Request

40xResponse

Example

{
  "title": "Bad Request",
  "status": 400,
  "timestamp": "2018-09-10T21:07:10-05:00",
  "detail": {
    "invalids": [
      {
        "field": "delimiter",
        "reason": "Unrecognized delimiter, valid options are comma, tab or pipe"
      }
    ]
  }
}

titlestring
statusinteger<int32>
Format
int32
timestampstring
detailobject
- invalidsobject[]
  - eventinteger
  - messagestring

403Forbidden

403Response
Example
```
{
  "message": "Forbidden"
}
```
- messagestring

404Not Found

40xResponse

Example

{
  "title": "Bad Request",
  "status": 404,
  "timestamp": "2018-09-10T21:07:10-05:00",
  "detail": {
    "message": "Not found description"
  }
}

titlestring
statusinteger<int32>
Format
int32
timestampstring
detailobject
- invalidsobject[]
  - eventinteger
  - messagestring

curl

curl --request POST \
     --url https://api.us1.odp.optimizely.com/v3/objects/{object_name} \
     --header 'accept: application/json'

javascript

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

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

fetch("https://api.us1.odp.optimizely.com/v3/objects/{object_name}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.us1.odp.optimizely.com/v3/objects/{object_name}")

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/json"

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

python

import requests
import json

url = "https://api.us1.odp.optimizely.com/v3/objects/{object_name}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

202

// Accepted
{
  "title": "",
  "status": "",
  "timestamp": ""
}

400

// Bad Request
{
  "title": "",
  "status": "",
  "timestamp": "",
  "detail": {
    "invalids": [
      {
        "event": 0,
        "message": ""
      }
    ]
  }
}

403

// Forbidden
{
  "message": ""
}

404

// Not Found
{
  "title": "",
  "status": "",
  "timestamp": "",
  "detail": {
    "invalids": [
      {
        "event": 0,
        "message": ""
      }
    ]
  }
}