Update Container

PATCH /containers/{id}
Copied
Arrow
                https://api.ocamba.com/v1/hood/containers/{id}

Updates the specific Container by setting the values of the parameters passed. Any parameters not provided will be left unchanged

path Parameters
Arrow
Name
Description
idstringrequired
Unique resource identifier.


Example: 12345
Request Body Schema
Arrow
Name
Description
analyticsobject

Name
Description
domainstring
Location where the analytics of the Container are located.


Example: t.ocmthood.com
enabledboolean
Determines wheather the analytics of the Container are enabler or not.


Example: true
overrideboolean
When set, enabled field is checked in the background. Only for Android and IOS type containers.


Example: true
applicationsobject

Name
Description
include_subdomainsboolean
Determines if the Container includes subdomains of the app.


Example: true
consentobject

Name
Description
enabledboolean
Determines if the Consent approved or not.


Example: true
overrideboolean
When set, enabled field is checked in the background. Only for Android and IOS type containers.


Example: true
descriptionstring
The description of the Container.


Example: This is an example of description.
namestringrequired
Name of the Container


Example: Container Example
pushobject

Name
Description
apns_envstring
Determines the Apns P12 Environment


Example: production

Possible values: production sandbox
apns_p12string
Dependant on the environment field. Only valid as a base64 encoded string and with valid password, if the certificate requires any. Only for IOS type tags.
apns_p12_passwordstring
The password of the Apns P12 certificate. Only for IOS type containers.
domainstring



Example: t.ocmhood.com
enabledboolean
Determines if Push is enabled or not.
firebase_admin_sdk_jsonstring
Must be a base64 encoded string representing the FirebaseAdminSdk object. Only for Android type containers.
overrideboolean
When set, enabled field is checked in the background. Only for Android and IOS type containerss.


Example: true
promptprompt
Prompt object.
Prompt
Name
Description
filters[ object ]
Array of prompt filter objects.
namestring
Name of the Prompt.


Example: New Native Prompt
optionsobject

Name
Description
actionmessage_colorstring
Action message color in RGB hexadecimal code.


Example: d94552
background_colorstring
Background color in RGB hexadecimal code.


Example: 4a88d9
category[ object ]
Array of category objects. Each object consists of two keys, one is 'name' and second is 'label'. Label represents text displayed to end user, and 'name' represents programmatic variable name.


Example: [ {"name":"key1","label":"sport"}, {"name":"key2","label":"politics"}, {"name":"key3","label":"business"} ]
delaynumber
Trigger window prompt after N seconds.


Example: 4
iconstring
Icon URL.


Example: https://icon.com/favicon.ico
label_colorstring
Label color in RGB hexadecimal code.


Example: 4a88d9
onclickboolean
Trigger window prompt in event of any user click on page.


Example: true
oncustomstring
Trigger window prompt on custom event with specific string with name of event, document.dispatchEvent(new Event("bilosta"));


Example: event
onscrollboolean
Trigger window prompt in event of any user scroll.


Example: true
state_button_negative_promptstring
Negative button name.


Example: Don't Allow
state_button_positive_promptstring
Positive button name.


Example: Allow
state_text_promptstring
Text which will be shown on window prompt.


Example: Allow notifications on your device to get latest news.
subscribe_backgroundstring
Subscribe background color in RGB hexadecimal code.


Example: 9479d9
subscribe_colorstring
Subscribe color in RGB hexadecimal code.


Example: 9479d9
unsubscribe_colorstring
Unsubscribe color in RGB hexadecimal code.


Example: e6543e
typestring
Type of the Prompt


Example: native

Possible values: slide | bell | link | native | html
service_workerobject

Name
Description
pathstring
Path of the Service Worker.


Example: /sw.js
statusstringrequired
Determines the status of the Container.


Example: active

Possible values: active verification rejected paused inactive pending disabled
Response status codes
Arrow
204 - No Content
Arrow

note
1 At least one of the updatable fields should be sent via HTTP body in order to change the current state of the container.
2 Web app names are sanitized to be all lowercase. Android and iOS app names stay the same.
tip
1 If you don't know the Container 'id', list the Containers to find it.
2 Patching the container with applications will replace the old applications array.

Request examples
Copied
Arrow
200 Arrow
  • 200
{
  "name": "Nikola Test Patch",
  "description": " Making a new version of Containers",
  "applications": [
    {
      "app": "exaple-app.com",
      "include_subdomains": true
    }
  ],
  "analytics": {
    "enabled": true,
    "domain": "devtest.com"
  }
}