Changelog

Custom property delete identifiers

Fixed contact matching in POST /contacts/custom-properties/delete/:

• Phone number identifiers now match the contact with that number.
• Email identifiers now match regardless of capitalisation or surrounding whitespace.

See Delete custom properties from contacts.

Segment user phone numbers

Fixed an issue where GET /segments/{segment_id}/users/ did not include a contact’s phone when Hive had one on file. See List segment users.

Hive API segment membership

Fixed an issue where contacts created through POST /contacts/ were not added to the brand’s auto-created Hive API segment, so they could not be filtered and targeted in the dashboard.

Contact birthdays

Fixed an issue where a birthday sent with POST /contacts/ was not saved on the contact. Birthdays are saved with the calendar day you sent and are available for segmentation and automations. See Contacts.

Stricter email validation

Contact and order requests now reject emails that Hive can’t save, instead of accepting them and dropping the contact or order later. An email must be at most 75 characters, use Latin characters only, and not contain symbols such as #, &, { or }. A request with an invalid email returns 422 with an error on the email field. See Contacts.

SMS and ad campaign reporting

Campaign reporting now covers SMS and Meta ad campaigns alongside email.

• SMS: list SMS campaigns, get stats for a campaign, and get aggregate stats across campaigns.
• Ads: list ad campaigns, get stats for a campaign, and get aggregate stats across campaigns.

Refresh token expiry

Refresh tokens now expire after 90 days of inactivity. Each refresh issues a new refresh token, so an integration that refreshes at least once every 90 days stays connected. See Token lifecycle.

Partial event updates

PATCH /events/{event_id}/ updates only the fields you send, without re-sending the full event. See Partially update an event.

Order validation and revenue

• POST /orders/ now returns 422 when an order references an event that doesn’t exist in Hive yet, instead of accepting it.
• Orders with duplicate item_id values are rejected with 422.
• Refunded and transferred tickets are no longer counted in order revenue.

Custom event properties

Define your own properties for events and send their values with each event.

• Create, list, rename, retype, and delete custom event property definitions with /events/custom-properties/. Deleting a property that’s in use requires force=true.
• Send property values in the new properties field on POST /events/. Values are type-checked against their definitions.

Hive API V2 beta launch

The Hive API V2 is now available in beta. Push contacts, orders, and events into Hive, manage segments, and read campaign reporting.

• Base URL: https://api.hive.co/v2
• Authentication: OAuth 2.0 Authorization Code Flow with PKCE. See Authentication & Authorization.
• Get started with the Quickstart.