Update Tag

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

Updates the specific Tag 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
appsapps
All apps that belongs to the Tag, categorized by type.
Apps
Name
Description
android[ string ]
Array of Android applications. Every item in array must be a valid Android app unique identifier (Package name). Android app names are case sensitive.
ios[ string ]
Array of IOS applications. Every item in array must be a valid IOS app unique identifier (Bundle ID). iOS app names are case sensitive.
web[ string ]
Array of Web applications. Every item in array must be a fully qualified domain name. Web app names are case insensitive and are sanitized to be lowercase.
descriptionstring
The more detailed description of the Tag.


Example: This is my first tag.
namestringrequired
The name of the tag, provided by the client.


Example: Demo Tag
settingsobjectrequired

Name
Description
generalobject

Name
Description
analyticsboolean



Example: true

Default: true
consentboolean



Example: true

Default: true
crashlyticsboolean



Example: true

Default: true
include_subdomainsboolean



Example: true

Default: true
pushboolean



Example: true

Default: true
statusstringrequired
The status of the tag. Statuses inactive, pending and disabled are deprecated and will be removed in the future. Prefer using active, verification, rejected or paused.


Example: active

Possible values: active verification rejected paused inactive pending disabled

Default: active
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 bid modifier.
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 Tag 'id', list the Tags to find it.

Request examples
Copied
Arrow
200 Arrow
  • 200
{
  "name": "Demo Tag",
  "status": "active",
  "apps": {
    "web": [
      "ocamba.com"
    ],
    "android": [
      "com.Ocamba.demo"
    ],
    "ios": [
      "com.ocamba.iosdemo"
    ]
  },
  "settings": {
    "general": {
      "include_subdomains": true,
      "analytics": true,
      "crashlytics": true,
      "push": true,
      "consent": true
    }
  },
  "description": "This is my first tag.",
}