Create Tag

POST /tags
Copied
Arrow
                https://api.ocamba.com/v1/hood/tags

Creates a Tag

Request Body Schema
Arrow
Name
Description
account_idstringrequired
The ID of the Account, generated by the Ocamba.


Example: 1000001
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
webobject

Name
Description
push_keystring



Example: KKV4lql8gxn0lC6NLiLWMSgGq9Orq7ZVYsbbspNlNthspH_Uul5DzG9nx_zUvRiCvox8bLfhvjYbqWfDv9iqbLze
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
201 - Created
Arrow
note
1 Web app names are sanitized to be all lowercase. Android and iOS app names stay the same. Mandatory fields are Tag Name and Account.
Request examples
Copied
Arrow
200 Arrow
  • 200
{       
  "account_id": "86446726",
  "name": "Tag",
  "status": "active",
  "apps": {
    "web": [
      "example.com"
    ],
    "android": [
      "com.example.demo"
    ],
    "ios": [
      "com.example.iosdemo"
    ]
    }
}
Response examples
Copied
Arrow
201 Arrow
  • 201
{
  "id": "1000",
  "company_id": "1000000",
  "account_id": "1000001",
  "account": {
    "id": "1000001",
    "status": "active",
    "configured_status": "active",
    "name": "Demo Account",
    "image": "https://path/logo.jpeg"
  },
  "creator_id": "1000002",
  "name": "Demo Tag",
  "status": "active",
  "apps": {
    "web": [
      "ocamba.com"
    ],
    "android": [
      "com.Ocamba.demo"
    ],
    "ios": [
      "com.ocamba.iosdemo"
    ]
  },
  "icon": "http://ocamba.storage.com/1000000/hood/tags/1000/icons/favicon.ico",
  "utm_ht": "NjY4bL60NobpWTQ2O94xNDY4MjE0Np6l",
  "settings": {
    "general": {
      "include_subdomains": true,
      "analytics": true,
      "push": true,
      "consent": true
    },
    "web": {
      "push_key": "KKV4lql8gxn0lC6NLiLWMSgGq9Orq7ZVYsbbspNlNthspH_Uul5DzG9nx_zUvRiCvox8bLfhvjYbqWfDv9iqbLze"
    }
  },
  "description": "This is my first tag.",
  "stats": {
    "pageviews": 10,
    "sessions": 6,
    "users": 4,
    "push_subscriptions": 2,
    "push_unsubscriptions": 1
  },
  "create_time": "2021-10-29 12:47:00",
  "update_time": "2021-10-30 14:27:26" 
}