General Formatting Conventions
IDs
When sending an ID such as an event_id
or registrant_id
, all IDs should be integer values.
Date-Times
Should be an ISO 8601 timestamp.
- Full Date-Time
YYYY-MM-DD HH:MM:SS
- Date Only
YYYY-MM-DD
- Time Only
HH:MM:SS
Time Zones
Can be sent as abbreviation, for example UTC
or EST
.
Currencies
Use 3-letter format—ISO 4217.
Addresses
- All country fields should use ISO 3166 Alpha-2 codes.
- State and province names should use the common 2-character acronym.
Boolean
- When sending
true
orfalse
values, use a 1 or 0 as an integer. - When you receive a JSON response,
true
andfalse
will be a primitive boolean type.
Expand
Some GET requests can include the expand
parameter.
- Expand Value Should be the singular comma-separated object type.
- Example
contact,location,registrant
Phone Number Format
We suggest all phone numbers to be submitted in the E.164 format. This means you should include the country code (e.g., +1
for the USA), followed by the national number without spaces or special characters. Here are some examples
- United States
+1234567890
- United Kingdom
+447911123456
- Australia
+61412345678
- Germany
+4915112345678
Following this format helps us ensure your number is valid and usable worldwide. For more details, you can learn about the E.164 standard here.
Note If this format is not received, we attempt to assign the correct country code, but it is not guaranteed to be correct.
Updated about 2 months ago