REFERRAL

Create Code

post/referral-codes

Request

  • Base URL: https://api.myaltimate.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.myaltimate.com/referral-codes
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

codestring nullable

If omitted, a 16-char URL-safe code is generated. Stored lowercase.

max_usesinteger nullable

Maximum redemptions. null = unlimited.

expires_atstring date-time nullable

null = never expires. Must be timezone-aware if provided.

Response

Successful Response

idinteger required
codestring required
is_activeboolean required
max_usesinteger nullable required
used_countinteger required
expires_atstring date-time nullable required
created_bystring nullable required
created_atstring date-time required

Changes

No recorded changes to this operation across all 82 revisions of this API.