Statuses - Omneo API

Website

Overview

Authentication

Profiles

Commerce

Incentives

Lists

Groups

Ratings and Interactions

Automation

Organisations and access

Configuration

Platform

Questionnaires

Use these endpoints for bulk status management or integration work. When reading or updating statuses for a specific customer, use Profile Statuses instead.

What is a status?

A Status is a special type of label, categorisation or tag that can be applied to a customer profile. Profile statuses help identify the profiles association with a brand. For example, a profile status could be “Influencer”, or “Stylist”. Statuses can be ranked in a hierarchy, and can even be used to influence Omneo Incentives.

See Tags and statuses for a full explanation of how statuses relate to profiles and incentive eligibility.

Status properties

Attributes	Description
id `INTEGER`	The unique Omneo ID for the definition
name `STRING`	The display name of the definition
handle `STRING`	A unique handle for the definition
sort_order `INTEGER`	The sort order of this status 0 = ascending -1 = descending
description `STRING`	The internal description for the definition
short_description `STRING`	A publicly available short description for this status
long_description `STRING`	A publicly available full HTML description of the status
terms_conditions	The terms and conditions associated with the status
icon	A valid URL for the icon associated with this status
image_url	A valid URL for the cover image associated with this status
earn_instructions	Instructions displayed to the customer, on how to earn this status
internal_notes	Internal notes attached to the status
created_at `STRING` `DATE-TIME` `READ-ONLY`	The UTC date & time the status record was created in ISO 8601 format.
updated_at `STRING` `DATE-TIME` `READ-ONLY`	The UTC date & time the status record was last updated in ISO 8601 format.

Delete Connection Definition Browse Statuses

⌘I

​What is a status?

​Status properties

What is a status?

Status properties