Skip to main content
POST
/
v3
/
profiles
/
{profile}
/
custom-event
Trigger Profile Custom Event
curl --request POST \
  --url http://localhost/api/v3/profiles/{profile}/custom-event \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": "<string>",
  "context": [
    "<string>"
  ]
}
'
{
  "data": {
    "id": "<string>",
    "external_id": "<string>",
    "title": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "full_name": "<string>",
    "email": "<string>",
    "gender": "<string>",
    "currency": "<string>",
    "joined_at": "<string>",
    "mobile_phone": "<string>",
    "mobile_phone_country": "<string>",
    "mobile_phone_national": "<string>",
    "mobile_phone_national_prefix": [
      "<unknown>"
    ],
    "mobile_phone_e164": "<string>",
    "secondary_phone": "<string>",
    "birth_year": 123,
    "birth_month": 123,
    "birth_day": 123,
    "company": "<string>",
    "occupation": "<string>",
    "avatar_url": "<string>",
    "preferred_location_id": 123,
    "joined_location_id": 123,
    "joined_location": {
      "id": 123,
      "type": "<string>",
      "name": "<string>",
      "handle": "<string>",
      "description": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "timezone": "<string>",
      "external_id": "<string>",
      "external_code": "<string>",
      "is_published": true,
      "is_permanently_closed": true,
      "address": {
        "id": 123,
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "address_line_3": "<string>",
        "company": "<string>",
        "latitude": 123,
        "longitude": 123,
        "city": "<string>",
        "postcode": "<string>",
        "state": "<string>",
        "country": "<string>",
        "notes": "<string>",
        "external_id": "<string>",
        "is_default": true,
        "created_at": "<string>",
        "updated_at": "<string>",
        "meta": [
          "<unknown>"
        ],
        "name": "<string>",
        "type": "<string>",
        "phone": "<string>",
        "iso": "<string>",
        "iso_state": "<string>",
        "profile_id": "<string>",
        "custom_fields": {}
      },
      "normal_hours": [
        [
          "<unknown>"
        ]
      ],
      "special_hours": [
        [
          "<unknown>"
        ]
      ],
      "tags": [
        "<string>"
      ],
      "custom_fields": {},
      "icon": "<string>",
      "country_iso_3": "<string>",
      "image_url": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "departments": [
        {
          "id": 123,
          "name": "<string>",
          "handle": "<string>",
          "external_id": "<string>",
          "external_code": "<string>",
          "description": "<string>",
          "short_description": "<string>",
          "url": "<string>",
          "image_url": "<string>",
          "internal_note": "<string>",
          "meta": [
            "<unknown>"
          ],
          "brand_id": 123,
          "location_id": 123,
          "brand": {
            "name": "<string>",
            "handle": "<string>"
          },
          "created_at": "<string>",
          "updated_at": "<string>"
        }
      ]
    },
    "preferred_location": {
      "id": 123,
      "type": "<string>",
      "name": "<string>",
      "handle": "<string>",
      "description": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "timezone": "<string>",
      "external_id": "<string>",
      "external_code": "<string>",
      "is_published": true,
      "is_permanently_closed": true,
      "address": {
        "id": 123,
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "address_line_3": "<string>",
        "company": "<string>",
        "latitude": 123,
        "longitude": 123,
        "city": "<string>",
        "postcode": "<string>",
        "state": "<string>",
        "country": "<string>",
        "notes": "<string>",
        "external_id": "<string>",
        "is_default": true,
        "created_at": "<string>",
        "updated_at": "<string>",
        "meta": [
          "<unknown>"
        ],
        "name": "<string>",
        "type": "<string>",
        "phone": "<string>",
        "iso": "<string>",
        "iso_state": "<string>",
        "profile_id": "<string>",
        "custom_fields": {}
      },
      "normal_hours": [
        [
          "<unknown>"
        ]
      ],
      "special_hours": [
        [
          "<unknown>"
        ]
      ],
      "tags": [
        "<string>"
      ],
      "custom_fields": {},
      "icon": "<string>",
      "country_iso_3": "<string>",
      "image_url": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "departments": [
        {
          "id": 123,
          "name": "<string>",
          "handle": "<string>",
          "external_id": "<string>",
          "external_code": "<string>",
          "description": "<string>",
          "short_description": "<string>",
          "url": "<string>",
          "image_url": "<string>",
          "internal_note": "<string>",
          "meta": [
            "<unknown>"
          ],
          "brand_id": 123,
          "location_id": 123,
          "brand": {
            "name": "<string>",
            "handle": "<string>"
          },
          "created_at": "<string>",
          "updated_at": "<string>"
        }
      ]
    },
    "preferred_staff_id": "<string>",
    "preferred_staff": {
      "id": "<string>",
      "full_name": "<string>",
      "email": "<string>",
      "identities": [
        {
          "id": 123,
          "handle": "<string>",
          "identifier": "<string>",
          "is_primary": true,
          "is_active": true,
          "profile_id": "<string>",
          "merged_from": "<string>",
          "created_at": "<string>",
          "updated_at": "<string>",
          "profile": {
            "id": "<string>",
            "external_id": "<string>",
            "title": "<string>",
            "first_name": "<string>",
            "last_name": "<string>",
            "full_name": "<string>",
            "email": "<string>",
            "gender": "<string>",
            "currency": "<string>",
            "joined_at": "<string>",
            "mobile_phone": "<string>",
            "mobile_phone_country": "<string>",
            "mobile_phone_national": "<string>",
            "mobile_phone_national_prefix": [
              "<unknown>"
            ],
            "mobile_phone_e164": "<string>",
            "secondary_phone": "<string>",
            "birth_year": "<string>",
            "birth_month": "<string>",
            "birth_day": "<string>",
            "company": "<string>",
            "occupation": "<string>",
            "avatar_url": "<string>",
            "preferred_location_id": "<string>",
            "joined_location_id": "<string>",
            "joined_location": {
              "id": 123,
              "type": "<string>",
              "name": "<string>",
              "handle": "<string>",
              "description": "<string>",
              "phone": "<string>",
              "email": "<string>",
              "timezone": "<string>",
              "external_id": "<string>",
              "external_code": "<string>",
              "is_published": true,
              "is_permanently_closed": true,
              "address": {
                "id": 123,
                "address_line_1": "<string>",
                "address_line_2": "<string>",
                "address_line_3": "<string>",
                "company": "<string>",
                "latitude": 123,
                "longitude": 123,
                "city": "<string>",
                "postcode": "<string>",
                "state": "<string>",
                "country": "<string>",
                "notes": "<string>",
                "external_id": "<string>",
                "is_default": true,
                "created_at": "<string>",
                "updated_at": "<string>",
                "meta": [
                  "<unknown>"
                ],
                "name": "<string>",
                "type": "<string>",
                "phone": "<string>",
                "iso": "<string>",
                "iso_state": "<string>",
                "profile_id": "<string>",
                "custom_fields": {}
              },
              "normal_hours": [
                [
                  "<unknown>"
                ]
              ],
              "special_hours": [
                [
                  "<unknown>"
                ]
              ],
              "tags": [
                "<string>"
              ],
              "custom_fields": {},
              "icon": "<string>",
              "country_iso_3": "<string>",
              "image_url": "<string>",
              "created_at": "<string>",
              "updated_at": "<string>",
              "departments": [
                {
                  "id": 123,
                  "name": "<string>",
                  "handle": "<string>",
                  "external_id": "<string>",
                  "external_code": "<string>",
                  "description": "<string>",
                  "short_description": "<string>",
                  "url": "<string>",
                  "image_url": "<string>",
                  "internal_note": "<string>",
                  "meta": [
                    "<unknown>"
                  ],
                  "brand_id": 123,
                  "location_id": 123,
                  "brand": {
                    "name": "<string>",
                    "handle": "<string>"
                  },
                  "created_at": "<string>",
                  "updated_at": "<string>"
                }
              ]
            },
            "preferred_location": {
              "id": 123,
              "type": "<string>",
              "name": "<string>",
              "handle": "<string>",
              "description": "<string>",
              "phone": "<string>",
              "email": "<string>",
              "timezone": "<string>",
              "external_id": "<string>",
              "external_code": "<string>",
              "is_published": true,
              "is_permanently_closed": true,
              "address": {
                "id": 123,
                "address_line_1": "<string>",
                "address_line_2": "<string>",
                "address_line_3": "<string>",
                "company": "<string>",
                "latitude": 123,
                "longitude": 123,
                "city": "<string>",
                "postcode": "<string>",
                "state": "<string>",
                "country": "<string>",
                "notes": "<string>",
                "external_id": "<string>",
                "is_default": true,
                "created_at": "<string>",
                "updated_at": "<string>",
                "meta": [
                  "<unknown>"
                ],
                "name": "<string>",
                "type": "<string>",
                "phone": "<string>",
                "iso": "<string>",
                "iso_state": "<string>",
                "profile_id": "<string>",
                "custom_fields": {}
              },
              "normal_hours": [
                [
                  "<unknown>"
                ]
              ],
              "special_hours": [
                [
                  "<unknown>"
                ]
              ],
              "tags": [
                "<string>"
              ],
              "custom_fields": {},
              "icon": "<string>",
              "country_iso_3": "<string>",
              "image_url": "<string>",
              "created_at": "<string>",
              "updated_at": "<string>",
              "departments": [
                {
                  "id": 123,
                  "name": "<string>",
                  "handle": "<string>",
                  "external_id": "<string>",
                  "external_code": "<string>",
                  "description": "<string>",
                  "short_description": "<string>",
                  "url": "<string>",
                  "image_url": "<string>",
                  "internal_note": "<string>",
                  "meta": [
                    "<unknown>"
                  ],
                  "brand_id": 123,
                  "location_id": 123,
                  "brand": {
                    "name": "<string>",
                    "handle": "<string>"
                  },
                  "created_at": "<string>",
                  "updated_at": "<string>"
                }
              ]
            },
            "tier_handle": "<string>",
            "tier": {
              "id": 123,
              "profile_id": "<string>",
              "name": "<string>",
              "handle": "<string>",
              "anniversary_at": "<string>",
              "maintained_at": "<string>",
              "assigned_at": "<string>",
              "achieved_at": "<string>"
            },
            "birth_date": "<string>",
            "birth_days": "<string>",
            "birth_days_past": "<string>",
            "next_birthday": "<string>",
            "tags": [
              "<string>"
            ],
            "attributes": {
              "comms": [
                "<unknown>"
              ],
              "appearance": {
                "profile_id": "<string>",
                "hair_colour": "<string>",
                "hair_length": "<string>",
                "shape_body": "<string>",
                "shape_face": "<string>",
                "size_cup": "<string>",
                "size_hat": "<string>",
                "size_formal_jacket": "<string>",
                "size_formal_jacket_length": "<string>",
                "size_formal_shirt": "<string>",
                "size_formal_shirt_fit": "<string>",
                "size_formal_trouser": "<string>",
                "size_formal_trouser_drop": "<string>",
                "size_formal_trouser_leg": "<string>",
                "size_jacket": "<string>",
                "size_pant": "<string>",
                "size_shoe": "<string>",
                "size_type_age": "<string>",
                "size_type_region": "<string>",
                "size_top": "<string>",
                "size_gloves": "<string>",
                "size_swimwear_top": "<string>",
                "size_swimwear_bottom": "<string>",
                "size_swimwear_cup": "<string>",
                "size_dress": "<string>",
                "skin_type": "<string>",
                "measurement_arm": "<string>",
                "measurement_arm_inside": "<string>",
                "measurement_bust": "<string>",
                "measurement_chest": "<string>",
                "measurement_foot_length": "<string>",
                "measurement_head": "<string>",
                "measurement_height": "<string>",
                "measurement_hip": "<string>",
                "measurement_leg_inside": "<string>",
                "measurement_leg_outside": "<string>",
                "measurement_neck": "<string>",
                "measurement_neck_to_wrist": "<string>",
                "measurement_shoulders": "<string>",
                "measurement_waist": "<string>",
                "measurement_weight": "<string>",
                "brow_colour": "<string>",
                "eye_colour": "<string>",
                "measurement_hand_right_thumb": "<string>",
                "measurement_hand_right_index": "<string>",
                "measurement_hand_right_middle": "<string>",
                "measurement_hand_right_ring": "<string>",
                "measurement_hand_right_pinky": "<string>",
                "measurement_hand_left_thumb": "<string>",
                "measurement_hand_left_index": "<string>",
                "measurement_hand_left_middle": "<string>",
                "measurement_hand_left_ring": "<string>",
                "measurement_hand_left_pinky": "<string>",
                "measurement_ear_helix": "<string>",
                "measurement_ear_forward_helix": "<string>",
                "measurement_ear_flat": "<string>",
                "measurement_ear_conch": "<string>",
                "measurement_ear_tragus": "<string>",
                "measurement_ear_lobe": "<string>",
                "created_at": "<string>",
                "updated_at": "<string>"
              },
              "dates": [
                {
                  "id": "<string>",
                  "profile_id": "<string>",
                  "date": "<string>",
                  "is_recurring": "<string>",
                  "recurring_schedule": "<string>",
                  "name": "<string>",
                  "handle": "<string>",
                  "relationship": "<string>",
                  "role": "<string>",
                  "description": "<string>",
                  "meta": "<string>",
                  "note": "<string>",
                  "links": [
                    {
                      "id": "<string>",
                      "attributes_date_id": "<string>",
                      "profile_id": "<string>",
                      "relationship": "<string>",
                      "role": "<string>",
                      "created_at": "<string>",
                      "updated_at": "<string>"
                    }
                  ],
                  "created_at": "<string>",
                  "updated_at": "<string>"
                }
              ]
            },
            "statuses": [
              "<unknown>"
            ],
            "statuses_original": [
              {
                "id": "<string>",
                "name": "<string>",
                "handle": "<string>",
                "sort_order": "<string>",
                "description": "<string>",
                "short_description": "<string>",
                "long_description": "<string>",
                "terms_conditions": "<string>",
                "icon": "<string>",
                "image_url": "<string>",
                "earn_instructions": "<string>",
                "colour": "<string>",
                "primary_colour": "<string>",
                "secondary_colour": "<string>",
                "text_colour": "<string>",
                "code": "<string>",
                "internal_notes": "<string>",
                "group_name": "<string>",
                "group_handle": "<string>",
                "timezone": "<string>",
                "period": "<string>",
                "period_type": "<string>",
                "absolute_expiry": "<string>",
                "created_at": "<string>",
                "updated_at": "<string>"
              }
            ],
            "custom_attributes": "<string>",
            "address": {
              "id": 123,
              "address_line_1": "<string>",
              "address_line_2": "<string>",
              "address_line_3": "<string>",
              "company": "<string>",
              "latitude": 123,
              "longitude": 123,
              "city": "<string>",
              "postcode": "<string>",
              "state": "<string>",
              "country": "<string>",
              "notes": "<string>",
              "external_id": "<string>",
              "is_default": true,
              "created_at": "<string>",
              "updated_at": "<string>",
              "meta": [
                "<unknown>"
              ],
              "name": "<string>",
              "type": "<string>",
              "phone": "<string>",
              "iso": "<string>",
              "iso_state": "<string>",
              "profile_id": "<string>",
              "custom_fields": {}
            },
            "addresses": [
              {
                "id": 123,
                "address_line_1": "<string>",
                "address_line_2": "<string>",
                "address_line_3": "<string>",
                "company": "<string>",
                "latitude": 123,
                "longitude": 123,
                "city": "<string>",
                "postcode": "<string>",
                "state": "<string>",
                "country": "<string>",
                "notes": "<string>",
                "external_id": "<string>",
                "is_default": true,
                "created_at": "<string>",
                "updated_at": "<string>",
                "meta": [
                  "<unknown>"
                ],
                "name": "<string>",
                "type": "<string>",
                "phone": "<string>",
                "iso": "<string>",
                "iso_state": "<string>",
                "profile_id": "<string>",
                "custom_fields": {}
              }
            ],
            "reward_balance": "<string>",
            "point_balance": "<string>",
            "benefit_balance": "<string>",
            "combined_balance_dollars": "<string>",
            "point_balance_dollars": "<string>",
            "created_at": "<string>",
            "updated_at": "<string>",
            "profile_type": "<string>",
            "region": {
              "id": "<string>",
              "name": "<string>",
              "handle": "<string>",
              "is_active": "<string>",
              "country": "<string>",
              "state": "<string>",
              "created_at": "<string>",
              "updated_at": "<string>"
            },
            "regions": [
              {
                "id": "<string>",
                "name": "<string>",
                "handle": "<string>",
                "is_active": "<string>",
                "country": "<string>",
                "state": "<string>",
                "created_at": "<string>",
                "updated_at": "<string>"
              }
            ]
          }
        }
      ]
    },
    "joined_staff_id": "<string>",
    "joined_staff": {
      "id": "<string>",
      "full_name": "<string>",
      "email": "<string>",
      "identities": [
        {
          "id": 123,
          "handle": "<string>",
          "identifier": "<string>",
          "is_primary": true,
          "is_active": true,
          "profile_id": "<string>",
          "merged_from": "<string>",
          "created_at": "<string>",
          "updated_at": "<string>",
          "profile": {
            "id": "<string>",
            "external_id": "<string>",
            "title": "<string>",
            "first_name": "<string>",
            "last_name": "<string>",
            "full_name": "<string>",
            "email": "<string>",
            "gender": "<string>",
            "currency": "<string>",
            "joined_at": "<string>",
            "mobile_phone": "<string>",
            "mobile_phone_country": "<string>",
            "mobile_phone_national": "<string>",
            "mobile_phone_national_prefix": [
              "<unknown>"
            ],
            "mobile_phone_e164": "<string>",
            "secondary_phone": "<string>",
            "birth_year": "<string>",
            "birth_month": "<string>",
            "birth_day": "<string>",
            "company": "<string>",
            "occupation": "<string>",
            "avatar_url": "<string>",
            "preferred_location_id": "<string>",
            "joined_location_id": "<string>",
            "joined_location": {
              "id": 123,
              "type": "<string>",
              "name": "<string>",
              "handle": "<string>",
              "description": "<string>",
              "phone": "<string>",
              "email": "<string>",
              "timezone": "<string>",
              "external_id": "<string>",
              "external_code": "<string>",
              "is_published": true,
              "is_permanently_closed": true,
              "address": {
                "id": 123,
                "address_line_1": "<string>",
                "address_line_2": "<string>",
                "address_line_3": "<string>",
                "company": "<string>",
                "latitude": 123,
                "longitude": 123,
                "city": "<string>",
                "postcode": "<string>",
                "state": "<string>",
                "country": "<string>",
                "notes": "<string>",
                "external_id": "<string>",
                "is_default": true,
                "created_at": "<string>",
                "updated_at": "<string>",
                "meta": [
                  "<unknown>"
                ],
                "name": "<string>",
                "type": "<string>",
                "phone": "<string>",
                "iso": "<string>",
                "iso_state": "<string>",
                "profile_id": "<string>",
                "custom_fields": {}
              },
              "normal_hours": [
                [
                  "<unknown>"
                ]
              ],
              "special_hours": [
                [
                  "<unknown>"
                ]
              ],
              "tags": [
                "<string>"
              ],
              "custom_fields": {},
              "icon": "<string>",
              "country_iso_3": "<string>",
              "image_url": "<string>",
              "created_at": "<string>",
              "updated_at": "<string>",
              "departments": [
                {
                  "id": 123,
                  "name": "<string>",
                  "handle": "<string>",
                  "external_id": "<string>",
                  "external_code": "<string>",
                  "description": "<string>",
                  "short_description": "<string>",
                  "url": "<string>",
                  "image_url": "<string>",
                  "internal_note": "<string>",
                  "meta": [
                    "<unknown>"
                  ],
                  "brand_id": 123,
                  "location_id": 123,
                  "brand": {
                    "name": "<string>",
                    "handle": "<string>"
                  },
                  "created_at": "<string>",
                  "updated_at": "<string>"
                }
              ]
            },
            "preferred_location": {
              "id": 123,
              "type": "<string>",
              "name": "<string>",
              "handle": "<string>",
              "description": "<string>",
              "phone": "<string>",
              "email": "<string>",
              "timezone": "<string>",
              "external_id": "<string>",
              "external_code": "<string>",
              "is_published": true,
              "is_permanently_closed": true,
              "address": {
                "id": 123,
                "address_line_1": "<string>",
                "address_line_2": "<string>",
                "address_line_3": "<string>",
                "company": "<string>",
                "latitude": 123,
                "longitude": 123,
                "city": "<string>",
                "postcode": "<string>",
                "state": "<string>",
                "country": "<string>",
                "notes": "<string>",
                "external_id": "<string>",
                "is_default": true,
                "created_at": "<string>",
                "updated_at": "<string>",
                "meta": [
                  "<unknown>"
                ],
                "name": "<string>",
                "type": "<string>",
                "phone": "<string>",
                "iso": "<string>",
                "iso_state": "<string>",
                "profile_id": "<string>",
                "custom_fields": {}
              },
              "normal_hours": [
                [
                  "<unknown>"
                ]
              ],
              "special_hours": [
                [
                  "<unknown>"
                ]
              ],
              "tags": [
                "<string>"
              ],
              "custom_fields": {},
              "icon": "<string>",
              "country_iso_3": "<string>",
              "image_url": "<string>",
              "created_at": "<string>",
              "updated_at": "<string>",
              "departments": [
                {
                  "id": 123,
                  "name": "<string>",
                  "handle": "<string>",
                  "external_id": "<string>",
                  "external_code": "<string>",
                  "description": "<string>",
                  "short_description": "<string>",
                  "url": "<string>",
                  "image_url": "<string>",
                  "internal_note": "<string>",
                  "meta": [
                    "<unknown>"
                  ],
                  "brand_id": 123,
                  "location_id": 123,
                  "brand": {
                    "name": "<string>",
                    "handle": "<string>"
                  },
                  "created_at": "<string>",
                  "updated_at": "<string>"
                }
              ]
            },
            "tier_handle": "<string>",
            "tier": {
              "id": 123,
              "profile_id": "<string>",
              "name": "<string>",
              "handle": "<string>",
              "anniversary_at": "<string>",
              "maintained_at": "<string>",
              "assigned_at": "<string>",
              "achieved_at": "<string>"
            },
            "birth_date": "<string>",
            "birth_days": "<string>",
            "birth_days_past": "<string>",
            "next_birthday": "<string>",
            "tags": [
              "<string>"
            ],
            "attributes": {
              "comms": [
                "<unknown>"
              ],
              "appearance": {
                "profile_id": "<string>",
                "hair_colour": "<string>",
                "hair_length": "<string>",
                "shape_body": "<string>",
                "shape_face": "<string>",
                "size_cup": "<string>",
                "size_hat": "<string>",
                "size_formal_jacket": "<string>",
                "size_formal_jacket_length": "<string>",
                "size_formal_shirt": "<string>",
                "size_formal_shirt_fit": "<string>",
                "size_formal_trouser": "<string>",
                "size_formal_trouser_drop": "<string>",
                "size_formal_trouser_leg": "<string>",
                "size_jacket": "<string>",
                "size_pant": "<string>",
                "size_shoe": "<string>",
                "size_type_age": "<string>",
                "size_type_region": "<string>",
                "size_top": "<string>",
                "size_gloves": "<string>",
                "size_swimwear_top": "<string>",
                "size_swimwear_bottom": "<string>",
                "size_swimwear_cup": "<string>",
                "size_dress": "<string>",
                "skin_type": "<string>",
                "measurement_arm": "<string>",
                "measurement_arm_inside": "<string>",
                "measurement_bust": "<string>",
                "measurement_chest": "<string>",
                "measurement_foot_length": "<string>",
                "measurement_head": "<string>",
                "measurement_height": "<string>",
                "measurement_hip": "<string>",
                "measurement_leg_inside": "<string>",
                "measurement_leg_outside": "<string>",
                "measurement_neck": "<string>",
                "measurement_neck_to_wrist": "<string>",
                "measurement_shoulders": "<string>",
                "measurement_waist": "<string>",
                "measurement_weight": "<string>",
                "brow_colour": "<string>",
                "eye_colour": "<string>",
                "measurement_hand_right_thumb": "<string>",
                "measurement_hand_right_index": "<string>",
                "measurement_hand_right_middle": "<string>",
                "measurement_hand_right_ring": "<string>",
                "measurement_hand_right_pinky": "<string>",
                "measurement_hand_left_thumb": "<string>",
                "measurement_hand_left_index": "<string>",
                "measurement_hand_left_middle": "<string>",
                "measurement_hand_left_ring": "<string>",
                "measurement_hand_left_pinky": "<string>",
                "measurement_ear_helix": "<string>",
                "measurement_ear_forward_helix": "<string>",
                "measurement_ear_flat": "<string>",
                "measurement_ear_conch": "<string>",
                "measurement_ear_tragus": "<string>",
                "measurement_ear_lobe": "<string>",
                "created_at": "<string>",
                "updated_at": "<string>"
              },
              "dates": [
                {
                  "id": "<string>",
                  "profile_id": "<string>",
                  "date": "<string>",
                  "is_recurring": "<string>",
                  "recurring_schedule": "<string>",
                  "name": "<string>",
                  "handle": "<string>",
                  "relationship": "<string>",
                  "role": "<string>",
                  "description": "<string>",
                  "meta": "<string>",
                  "note": "<string>",
                  "links": [
                    {
                      "id": "<string>",
                      "attributes_date_id": "<string>",
                      "profile_id": "<string>",
                      "relationship": "<string>",
                      "role": "<string>",
                      "created_at": "<string>",
                      "updated_at": "<string>"
                    }
                  ],
                  "created_at": "<string>",
                  "updated_at": "<string>"
                }
              ]
            },
            "statuses": [
              "<unknown>"
            ],
            "statuses_original": [
              {
                "id": "<string>",
                "name": "<string>",
                "handle": "<string>",
                "sort_order": "<string>",
                "description": "<string>",
                "short_description": "<string>",
                "long_description": "<string>",
                "terms_conditions": "<string>",
                "icon": "<string>",
                "image_url": "<string>",
                "earn_instructions": "<string>",
                "colour": "<string>",
                "primary_colour": "<string>",
                "secondary_colour": "<string>",
                "text_colour": "<string>",
                "code": "<string>",
                "internal_notes": "<string>",
                "group_name": "<string>",
                "group_handle": "<string>",
                "timezone": "<string>",
                "period": "<string>",
                "period_type": "<string>",
                "absolute_expiry": "<string>",
                "created_at": "<string>",
                "updated_at": "<string>"
              }
            ],
            "custom_attributes": "<string>",
            "address": {
              "id": 123,
              "address_line_1": "<string>",
              "address_line_2": "<string>",
              "address_line_3": "<string>",
              "company": "<string>",
              "latitude": 123,
              "longitude": 123,
              "city": "<string>",
              "postcode": "<string>",
              "state": "<string>",
              "country": "<string>",
              "notes": "<string>",
              "external_id": "<string>",
              "is_default": true,
              "created_at": "<string>",
              "updated_at": "<string>",
              "meta": [
                "<unknown>"
              ],
              "name": "<string>",
              "type": "<string>",
              "phone": "<string>",
              "iso": "<string>",
              "iso_state": "<string>",
              "profile_id": "<string>",
              "custom_fields": {}
            },
            "addresses": [
              {
                "id": 123,
                "address_line_1": "<string>",
                "address_line_2": "<string>",
                "address_line_3": "<string>",
                "company": "<string>",
                "latitude": 123,
                "longitude": 123,
                "city": "<string>",
                "postcode": "<string>",
                "state": "<string>",
                "country": "<string>",
                "notes": "<string>",
                "external_id": "<string>",
                "is_default": true,
                "created_at": "<string>",
                "updated_at": "<string>",
                "meta": [
                  "<unknown>"
                ],
                "name": "<string>",
                "type": "<string>",
                "phone": "<string>",
                "iso": "<string>",
                "iso_state": "<string>",
                "profile_id": "<string>",
                "custom_fields": {}
              }
            ],
            "reward_balance": "<string>",
            "point_balance": "<string>",
            "benefit_balance": "<string>",
            "combined_balance_dollars": "<string>",
            "point_balance_dollars": "<string>",
            "created_at": "<string>",
            "updated_at": "<string>",
            "profile_type": "<string>",
            "region": {
              "id": "<string>",
              "name": "<string>",
              "handle": "<string>",
              "is_active": "<string>",
              "country": "<string>",
              "state": "<string>",
              "created_at": "<string>",
              "updated_at": "<string>"
            },
            "regions": [
              {
                "id": "<string>",
                "name": "<string>",
                "handle": "<string>",
                "is_active": "<string>",
                "country": "<string>",
                "state": "<string>",
                "created_at": "<string>",
                "updated_at": "<string>"
              }
            ]
          }
        }
      ]
    },
    "tier_handle": "<string>",
    "tier": {
      "id": 123,
      "profile_id": "<string>",
      "name": "<string>",
      "handle": "<string>",
      "anniversary_at": "<string>",
      "maintained_at": "<string>",
      "assigned_at": "<string>",
      "achieved_at": "<string>"
    },
    "birth_date": "<string>",
    "birth_days": "<string>",
    "birth_days_past": "<string>",
    "next_birthday": "<string>",
    "identities": [
      {
        "id": 123,
        "handle": "<string>",
        "identifier": "<string>",
        "is_primary": true,
        "is_active": true,
        "profile_id": "<string>",
        "merged_from": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "profile": {
          "id": "<string>",
          "external_id": "<string>",
          "title": "<string>",
          "first_name": "<string>",
          "last_name": "<string>",
          "full_name": "<string>",
          "email": "<string>",
          "gender": "<string>",
          "currency": "<string>",
          "joined_at": "<string>",
          "mobile_phone": "<string>",
          "mobile_phone_country": "<string>",
          "mobile_phone_national": "<string>",
          "mobile_phone_national_prefix": [
            "<unknown>"
          ],
          "mobile_phone_e164": "<string>",
          "secondary_phone": "<string>",
          "birth_year": "<string>",
          "birth_month": "<string>",
          "birth_day": "<string>",
          "company": "<string>",
          "occupation": "<string>",
          "avatar_url": "<string>",
          "preferred_location_id": "<string>",
          "joined_location_id": "<string>",
          "joined_location": {
            "id": 123,
            "type": "<string>",
            "name": "<string>",
            "handle": "<string>",
            "description": "<string>",
            "phone": "<string>",
            "email": "<string>",
            "timezone": "<string>",
            "external_id": "<string>",
            "external_code": "<string>",
            "is_published": true,
            "is_permanently_closed": true,
            "address": {
              "id": 123,
              "address_line_1": "<string>",
              "address_line_2": "<string>",
              "address_line_3": "<string>",
              "company": "<string>",
              "latitude": 123,
              "longitude": 123,
              "city": "<string>",
              "postcode": "<string>",
              "state": "<string>",
              "country": "<string>",
              "notes": "<string>",
              "external_id": "<string>",
              "is_default": true,
              "created_at": "<string>",
              "updated_at": "<string>",
              "meta": [
                "<unknown>"
              ],
              "name": "<string>",
              "type": "<string>",
              "phone": "<string>",
              "iso": "<string>",
              "iso_state": "<string>",
              "profile_id": "<string>",
              "custom_fields": {}
            },
            "normal_hours": [
              [
                "<unknown>"
              ]
            ],
            "special_hours": [
              [
                "<unknown>"
              ]
            ],
            "tags": [
              "<string>"
            ],
            "custom_fields": {},
            "icon": "<string>",
            "country_iso_3": "<string>",
            "image_url": "<string>",
            "created_at": "<string>",
            "updated_at": "<string>",
            "departments": [
              {
                "id": 123,
                "name": "<string>",
                "handle": "<string>",
                "external_id": "<string>",
                "external_code": "<string>",
                "description": "<string>",
                "short_description": "<string>",
                "url": "<string>",
                "image_url": "<string>",
                "internal_note": "<string>",
                "meta": [
                  "<unknown>"
                ],
                "brand_id": 123,
                "location_id": 123,
                "brand": {
                  "name": "<string>",
                  "handle": "<string>"
                },
                "created_at": "<string>",
                "updated_at": "<string>"
              }
            ]
          },
          "preferred_location": {
            "id": 123,
            "type": "<string>",
            "name": "<string>",
            "handle": "<string>",
            "description": "<string>",
            "phone": "<string>",
            "email": "<string>",
            "timezone": "<string>",
            "external_id": "<string>",
            "external_code": "<string>",
            "is_published": true,
            "is_permanently_closed": true,
            "address": {
              "id": 123,
              "address_line_1": "<string>",
              "address_line_2": "<string>",
              "address_line_3": "<string>",
              "company": "<string>",
              "latitude": 123,
              "longitude": 123,
              "city": "<string>",
              "postcode": "<string>",
              "state": "<string>",
              "country": "<string>",
              "notes": "<string>",
              "external_id": "<string>",
              "is_default": true,
              "created_at": "<string>",
              "updated_at": "<string>",
              "meta": [
                "<unknown>"
              ],
              "name": "<string>",
              "type": "<string>",
              "phone": "<string>",
              "iso": "<string>",
              "iso_state": "<string>",
              "profile_id": "<string>",
              "custom_fields": {}
            },
            "normal_hours": [
              [
                "<unknown>"
              ]
            ],
            "special_hours": [
              [
                "<unknown>"
              ]
            ],
            "tags": [
              "<string>"
            ],
            "custom_fields": {},
            "icon": "<string>",
            "country_iso_3": "<string>",
            "image_url": "<string>",
            "created_at": "<string>",
            "updated_at": "<string>",
            "departments": [
              {
                "id": 123,
                "name": "<string>",
                "handle": "<string>",
                "external_id": "<string>",
                "external_code": "<string>",
                "description": "<string>",
                "short_description": "<string>",
                "url": "<string>",
                "image_url": "<string>",
                "internal_note": "<string>",
                "meta": [
                  "<unknown>"
                ],
                "brand_id": 123,
                "location_id": 123,
                "brand": {
                  "name": "<string>",
                  "handle": "<string>"
                },
                "created_at": "<string>",
                "updated_at": "<string>"
              }
            ]
          },
          "tier_handle": "<string>",
          "tier": {
            "id": 123,
            "profile_id": "<string>",
            "name": "<string>",
            "handle": "<string>",
            "anniversary_at": "<string>",
            "maintained_at": "<string>",
            "assigned_at": "<string>",
            "achieved_at": "<string>"
          },
          "birth_date": "<string>",
          "birth_days": "<string>",
          "birth_days_past": "<string>",
          "next_birthday": "<string>",
          "tags": [
            "<string>"
          ],
          "attributes": {
            "comms": [
              "<unknown>"
            ],
            "appearance": {
              "profile_id": "<string>",
              "hair_colour": "<string>",
              "hair_length": "<string>",
              "shape_body": "<string>",
              "shape_face": "<string>",
              "size_cup": "<string>",
              "size_hat": "<string>",
              "size_formal_jacket": "<string>",
              "size_formal_jacket_length": "<string>",
              "size_formal_shirt": "<string>",
              "size_formal_shirt_fit": "<string>",
              "size_formal_trouser": "<string>",
              "size_formal_trouser_drop": "<string>",
              "size_formal_trouser_leg": "<string>",
              "size_jacket": "<string>",
              "size_pant": "<string>",
              "size_shoe": "<string>",
              "size_type_age": "<string>",
              "size_type_region": "<string>",
              "size_top": "<string>",
              "size_gloves": "<string>",
              "size_swimwear_top": "<string>",
              "size_swimwear_bottom": "<string>",
              "size_swimwear_cup": "<string>",
              "size_dress": "<string>",
              "skin_type": "<string>",
              "measurement_arm": "<string>",
              "measurement_arm_inside": "<string>",
              "measurement_bust": "<string>",
              "measurement_chest": "<string>",
              "measurement_foot_length": "<string>",
              "measurement_head": "<string>",
              "measurement_height": "<string>",
              "measurement_hip": "<string>",
              "measurement_leg_inside": "<string>",
              "measurement_leg_outside": "<string>",
              "measurement_neck": "<string>",
              "measurement_neck_to_wrist": "<string>",
              "measurement_shoulders": "<string>",
              "measurement_waist": "<string>",
              "measurement_weight": "<string>",
              "brow_colour": "<string>",
              "eye_colour": "<string>",
              "measurement_hand_right_thumb": "<string>",
              "measurement_hand_right_index": "<string>",
              "measurement_hand_right_middle": "<string>",
              "measurement_hand_right_ring": "<string>",
              "measurement_hand_right_pinky": "<string>",
              "measurement_hand_left_thumb": "<string>",
              "measurement_hand_left_index": "<string>",
              "measurement_hand_left_middle": "<string>",
              "measurement_hand_left_ring": "<string>",
              "measurement_hand_left_pinky": "<string>",
              "measurement_ear_helix": "<string>",
              "measurement_ear_forward_helix": "<string>",
              "measurement_ear_flat": "<string>",
              "measurement_ear_conch": "<string>",
              "measurement_ear_tragus": "<string>",
              "measurement_ear_lobe": "<string>",
              "created_at": "<string>",
              "updated_at": "<string>"
            },
            "dates": [
              {
                "id": "<string>",
                "profile_id": "<string>",
                "date": "<string>",
                "is_recurring": "<string>",
                "recurring_schedule": "<string>",
                "name": "<string>",
                "handle": "<string>",
                "relationship": "<string>",
                "role": "<string>",
                "description": "<string>",
                "meta": "<string>",
                "note": "<string>",
                "links": [
                  {
                    "id": "<string>",
                    "attributes_date_id": "<string>",
                    "profile_id": "<string>",
                    "relationship": "<string>",
                    "role": "<string>",
                    "created_at": "<string>",
                    "updated_at": "<string>"
                  }
                ],
                "created_at": "<string>",
                "updated_at": "<string>"
              }
            ]
          },
          "statuses": [
            "<unknown>"
          ],
          "statuses_original": [
            {
              "id": "<string>",
              "name": "<string>",
              "handle": "<string>",
              "sort_order": "<string>",
              "description": "<string>",
              "short_description": "<string>",
              "long_description": "<string>",
              "terms_conditions": "<string>",
              "icon": "<string>",
              "image_url": "<string>",
              "earn_instructions": "<string>",
              "colour": "<string>",
              "primary_colour": "<string>",
              "secondary_colour": "<string>",
              "text_colour": "<string>",
              "code": "<string>",
              "internal_notes": "<string>",
              "group_name": "<string>",
              "group_handle": "<string>",
              "timezone": "<string>",
              "period": "<string>",
              "period_type": "<string>",
              "absolute_expiry": "<string>",
              "created_at": "<string>",
              "updated_at": "<string>"
            }
          ],
          "custom_attributes": "<string>",
          "address": {
            "id": 123,
            "address_line_1": "<string>",
            "address_line_2": "<string>",
            "address_line_3": "<string>",
            "company": "<string>",
            "latitude": 123,
            "longitude": 123,
            "city": "<string>",
            "postcode": "<string>",
            "state": "<string>",
            "country": "<string>",
            "notes": "<string>",
            "external_id": "<string>",
            "is_default": true,
            "created_at": "<string>",
            "updated_at": "<string>",
            "meta": [
              "<unknown>"
            ],
            "name": "<string>",
            "type": "<string>",
            "phone": "<string>",
            "iso": "<string>",
            "iso_state": "<string>",
            "profile_id": "<string>",
            "custom_fields": {}
          },
          "addresses": [
            {
              "id": 123,
              "address_line_1": "<string>",
              "address_line_2": "<string>",
              "address_line_3": "<string>",
              "company": "<string>",
              "latitude": 123,
              "longitude": 123,
              "city": "<string>",
              "postcode": "<string>",
              "state": "<string>",
              "country": "<string>",
              "notes": "<string>",
              "external_id": "<string>",
              "is_default": true,
              "created_at": "<string>",
              "updated_at": "<string>",
              "meta": [
                "<unknown>"
              ],
              "name": "<string>",
              "type": "<string>",
              "phone": "<string>",
              "iso": "<string>",
              "iso_state": "<string>",
              "profile_id": "<string>",
              "custom_fields": {}
            }
          ],
          "reward_balance": "<string>",
          "point_balance": "<string>",
          "benefit_balance": "<string>",
          "combined_balance_dollars": "<string>",
          "point_balance_dollars": "<string>",
          "created_at": "<string>",
          "updated_at": "<string>",
          "profile_type": "<string>",
          "region": {
            "id": "<string>",
            "name": "<string>",
            "handle": "<string>",
            "is_active": "<string>",
            "country": "<string>",
            "state": "<string>",
            "created_at": "<string>",
            "updated_at": "<string>"
          },
          "regions": [
            {
              "id": "<string>",
              "name": "<string>",
              "handle": "<string>",
              "is_active": "<string>",
              "country": "<string>",
              "state": "<string>",
              "created_at": "<string>",
              "updated_at": "<string>"
            }
          ]
        }
      }
    ],
    "tags": [
      "<string>"
    ],
    "attributes": {
      "comms": [
        "<unknown>"
      ],
      "appearance": {
        "profile_id": "<string>",
        "hair_colour": "<string>",
        "hair_length": "<string>",
        "shape_body": "<string>",
        "shape_face": "<string>",
        "size_cup": "<string>",
        "size_hat": "<string>",
        "size_formal_jacket": "<string>",
        "size_formal_jacket_length": "<string>",
        "size_formal_shirt": "<string>",
        "size_formal_shirt_fit": "<string>",
        "size_formal_trouser": "<string>",
        "size_formal_trouser_drop": "<string>",
        "size_formal_trouser_leg": "<string>",
        "size_jacket": "<string>",
        "size_pant": "<string>",
        "size_shoe": "<string>",
        "size_type_age": "<string>",
        "size_type_region": "<string>",
        "size_top": "<string>",
        "size_gloves": "<string>",
        "size_swimwear_top": "<string>",
        "size_swimwear_bottom": "<string>",
        "size_swimwear_cup": "<string>",
        "size_dress": "<string>",
        "skin_type": "<string>",
        "measurement_arm": "<string>",
        "measurement_arm_inside": "<string>",
        "measurement_bust": "<string>",
        "measurement_chest": "<string>",
        "measurement_foot_length": "<string>",
        "measurement_head": "<string>",
        "measurement_height": "<string>",
        "measurement_hip": "<string>",
        "measurement_leg_inside": "<string>",
        "measurement_leg_outside": "<string>",
        "measurement_neck": "<string>",
        "measurement_neck_to_wrist": "<string>",
        "measurement_shoulders": "<string>",
        "measurement_waist": "<string>",
        "measurement_weight": "<string>",
        "brow_colour": "<string>",
        "eye_colour": "<string>",
        "measurement_hand_right_thumb": "<string>",
        "measurement_hand_right_index": "<string>",
        "measurement_hand_right_middle": "<string>",
        "measurement_hand_right_ring": "<string>",
        "measurement_hand_right_pinky": "<string>",
        "measurement_hand_left_thumb": "<string>",
        "measurement_hand_left_index": "<string>",
        "measurement_hand_left_middle": "<string>",
        "measurement_hand_left_ring": "<string>",
        "measurement_hand_left_pinky": "<string>",
        "measurement_ear_helix": "<string>",
        "measurement_ear_forward_helix": "<string>",
        "measurement_ear_flat": "<string>",
        "measurement_ear_conch": "<string>",
        "measurement_ear_tragus": "<string>",
        "measurement_ear_lobe": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>"
      },
      "dates": [
        {
          "id": "<string>",
          "profile_id": "<string>",
          "date": "<string>",
          "is_recurring": "<string>",
          "recurring_schedule": "<string>",
          "name": "<string>",
          "handle": "<string>",
          "relationship": "<string>",
          "role": "<string>",
          "description": "<string>",
          "meta": "<string>",
          "note": "<string>",
          "links": [
            {
              "id": "<string>",
              "attributes_date_id": "<string>",
              "profile_id": "<string>",
              "relationship": "<string>",
              "role": "<string>",
              "created_at": "<string>",
              "updated_at": "<string>"
            }
          ],
          "created_at": "<string>",
          "updated_at": "<string>"
        }
      ]
    },
    "statuses": [
      "<unknown>"
    ],
    "statuses_original": [
      {
        "id": "<string>",
        "name": "<string>",
        "handle": "<string>",
        "sort_order": "<string>",
        "description": "<string>",
        "short_description": "<string>",
        "long_description": "<string>",
        "terms_conditions": "<string>",
        "icon": "<string>",
        "image_url": "<string>",
        "earn_instructions": "<string>",
        "colour": "<string>",
        "text_colour": "<string>",
        "primary_colour": "<string>",
        "secondary_colour": "<string>",
        "code": "<string>",
        "internal_notes": "<string>",
        "group_name": "<string>",
        "group_handle": "<string>",
        "timezone": "<string>",
        "period": "<string>",
        "period_type": "<string>",
        "absolute_expiry": "<string>",
        "expires_at": "<string>",
        "is_active": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    ],
    "custom_attributes": {},
    "address": {
      "id": 123,
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "address_line_3": "<string>",
      "company": "<string>",
      "latitude": 123,
      "longitude": 123,
      "city": "<string>",
      "postcode": "<string>",
      "state": "<string>",
      "country": "<string>",
      "notes": "<string>",
      "external_id": "<string>",
      "is_default": true,
      "created_at": "<string>",
      "updated_at": "<string>",
      "meta": [
        "<unknown>"
      ],
      "name": "<string>",
      "type": "<string>",
      "phone": "<string>",
      "iso": "<string>",
      "iso_state": "<string>",
      "profile_id": "<string>",
      "custom_fields": {}
    },
    "addresses": [
      {
        "id": 123,
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "address_line_3": "<string>",
        "company": "<string>",
        "latitude": 123,
        "longitude": 123,
        "city": "<string>",
        "postcode": "<string>",
        "state": "<string>",
        "country": "<string>",
        "notes": "<string>",
        "external_id": "<string>",
        "is_default": true,
        "created_at": "<string>",
        "updated_at": "<string>",
        "meta": [
          "<unknown>"
        ],
        "name": "<string>",
        "type": "<string>",
        "phone": "<string>",
        "iso": "<string>",
        "iso_state": "<string>",
        "profile_id": "<string>",
        "custom_fields": {}
      }
    ],
    "reward_balance": "<string>",
    "point_balance": "<string>",
    "benefit_balance": "<string>",
    "credit_balance": "<string>",
    "combined_balance_dollars": "<string>",
    "point_balance_dollars": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "is_public": true,
    "profile_type": "<string>",
    "created_by": "<string>",
    "region": {
      "id": "<string>",
      "name": "<string>",
      "handle": "<string>",
      "is_active": "<string>",
      "country": "<string>",
      "state": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    },
    "regions": [
      {
        "id": "<string>",
        "name": "<string>",
        "handle": "<string>",
        "is_active": "<string>",
        "country": "<string>",
        "state": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    ],
    "organisations": [
      {
        "id": "<string>",
        "name": "<string>",
        "handle": "<string>",
        "description": "<string>",
        "short_description": "<string>",
        "icon": "<string>",
        "image_url": "<string>",
        "notes": "<string>",
        "type": "<string>",
        "status": "<string>",
        "is_tenant": "<string>",
        "is_active": "<string>",
        "phone": "<string>",
        "email": "<string>",
        "secondary_phone": "<string>",
        "domain": "<string>",
        "authorised_domains": "<string>",
        "role_definition": {
          "id": "<string>",
          "name": "<string>",
          "handle": "<string>",
          "description": "<string>"
        },
        "expires_at": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    ],
    "normal_hours": [
      {
        "id": "<string>",
        "day_of_week": "<string>",
        "is_closed": "<string>",
        "available_from": "<string>",
        "available_until": "<string>"
      }
    ],
    "special_hours": [
      {
        "id": "<string>",
        "name": "<string>",
        "is_repeating": "<string>",
        "is_closed": "<string>",
        "available_from": "<string>",
        "available_until": "<string>",
        "start_at": "<string>",
        "end_at": "<string>"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

profile
string<uuid>
required

The profile ID

Body

application/json
event
string
required
context
string[] | null

Response

Profile

data
Profile · object
required