Create Segment
Copied
https://api.ocamba.com/v1/hood/segments
Copied
https://api.ocamba.com/v1/hood/segments
Creates a new Segment object
Name
Descriptionnamestring
Segment name, maximum length 65 characters.Example: example_segment_name
statusstring
Segment status, accepted values are inactive and active.Example: active
targetingsegment-targeting
Targeting object.Segment targeting
Name
Descriptionaccountsobject
Name
Descriptionitems[ string ]
List of account ids with unique items and minimum length of 1. This field is deprecated and will be removed in future. Please use partner as a replacement.opstring
Example: eq
Possible values: eq | neq
application_groupsobject
Name
Descriptionitems[ string ]
Array of hood application group ids created by the Ocamba platform.opstring
Example: neq
Possible values: eq | neq
applicationsobject
Name
Descriptionitems[ string ]
List of application ids with unique items and minimum length of 1. Every item should be valid full qualified domain name and can contain star (*).opstring
Example: eq
Possible values: eq | neq
browsersobject
Name
Descriptionitems[ string ]
Array of browser ids supported by Ocamba, max 100 items.opstring
Example: eq
Possible values: eq | neq
containersobject
Name
Descriptionitems[ string ]
Array of hood containers ids created on Ocamba platform, max 100 items.opstring
Example: eq
Possible values: eq | neq
countriesobject
Name
Descriptionitems[ string ]
Array of country codes supported by Ocamba (ISO 3166-1, 2 letter country codes), max 270 items.opstring
Example: eq
Possible values: eq | neq
engagement_scoreobject
Name
Descriptionfromnumber (integer)
Describes the lower threshold for engagement score when targeting users. Minimum value is 0, maximum is 100.Example: 11
tonumber (integer)
Describes the upper threshold for engagement score when targeting users. Minimum value is 1, maximum is 100.Example: 73
groupsobject
Name
Descriptionitems[ string ]
Array of hood group ids created on Ocamba platform, max 100 items.opstring
Example: eq
Possible values: eq | neq
languagesobject
Name
Descriptionitems[ string ]
Array of language codes supported by Ocamba (ISO 639-2, 2 letter language codes), max 50 items.opstring
Example: eq
Possible values: eq | neq
osobject
Name
Descriptionitems[ string ]
Array of os ids supported by Ocamba, max 50 items.opstring
Example: eq
Possible values: eq | neq
partnersobject
Name
Descriptionitems[ string ]
List of partners ids with unique items and minimum length of 1.opstring
Example: eq
Possible values: eq | neq
regionsobject
Name
Descriptionitems[ string ]
Region ids.opstring
Example: eq
Possible values: eq | neq
remote_usersobject
Name
Descriptionitems[ string ]
Array of remote user ids maximum length of 100, tracked by Ocamba platform, max 100 items.opstring
Example: eq
Possible values: eq | neq
subscribed_ageobject
Name
Descriptionfromnumber (integer)
Number in range 0-3500Example: 10
tonumber (integer)
Number in range 1-3500. Must be greater than 'from' field.Example: 100
tagsobject
Name
Descriptionitems[ string ]
Array of hood tag ids created on Ocamba platform, max 100 items. This field is deprecated and will be removed in future. Please use container as a replacement.opstring
Example: eq
Possible values: eq | neq
user_dataobject
Name
Descriptionkeystring
Key can be any string which represents user specific data, max 100 characters. Key will be sanitized by removing leading and trailing whitespace, replacing all consecutive non-leading and non-trailing whitespaces with a single underscore, converting all character to lowercase and using only first 100 characters if there are over 100 characters.valueobject
Name
Descriptionitems[ string ]
Array of values, maximum 10 items.opstring
Example: eq
Possible values: eq | neq
usersobject
Name
Descriptionitems[ string ]
Array of user ids tracked by Ocamba platform, max 100 items.opstring
Example: eq
Possible values: eq | neq
201 - Created
note
1 At least one target is required.
2 We recommend using partners instead of accounts, as accounts are deprecated. If both parameters are sent, partners will take priority.