Referral Groups
Cancel a group
POST
/
groups
/
{id}
/
cancel
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
id
string
requiredUnique group ID
Response
200 - application/json
id
string
requiredThe id of the group.
shareId
string | null
requiredThe shared identifier of the group. If null, it will create a group. If not null, it will join the group.
livemode
boolean
requiredWether the order is in live mode or test mode.
organizationId
string
requiredThe id of the organization.
customerId
string
requiredThe id of the customer.
creatorEmail
string
requiredThe email of the creator of the group.
status
enum<string>
requiredThe status of the group.
Available options:
OPEN
, COMPLETED
, CANCELED
, EXPIRED
metadata
object
requiredAdditional metadata for the order.
expiresAt
string
requiredmidExpireAt
string
requiredjMinus2ExpireAt
string
requiredjPlus3StartAt
string
requiredreminderEmailSent
enum<string>
requiredThe reminder email sent status of the group.
Available options:
NOT_SENT
, MIDWAY_SENT
, DAY3_SENT
, DAY2_BEFORE_END_SENT
createdAt
string
requiredcreatedBy
string | null
requiredThe id of the user who created the customer.
updatedAt
string
requiredupdatedBy
string | null
requiredThe id of the user who last updated the customer.
canceledAt
string
requiredcompletedAt
string
required