# POST /referrals.json

**POST /referrals.json**




## Servers
- http://api.example.com/v1: http://api.example.com/v1 ()


## Authentication methods
- Bearer auth


## Parameters



### Body: application/json (object)

- **about** (string | null)
  About
- **addressLineOne** (string | null)
  Address line one
- **addressLineTwo** (string | null)
  Address line two
- **authenticationSecret** (string | null)
  Authentication secret
- **authenticationToken** (string | null)
  Authentication token
- **city** (string | null)
  City
- **commissionRate** (number | null)
  Commission rate
- **country** (string | null)
  Country
- **email** (string)
  Email
- **iso** (string)
  Iso
- **logo** (string | null)
  Logo
- **name** (string)
  Name
- **orderEndpointUrl** (string | null)
  Order endpoint url
- **phone** (string | null)
  Phone
- **platform** (string)
  Platform
- **referralCode** (string)
  Referral code
- **returnsPolicy** (string | null)
  Returns policy
- **shopifyStoreId** (integer(int32) | null)
  Shopify store
- **sourceType** (string | null)
  Source type
- **state** (string | null)
  State
- **stripeId** (string | null)
  Stripe
- **welcomeMessage** (string | null)
  Welcome message
- **wooCommerceStoreId** (integer(int32) | null)
  Woo commerce store
- **zip** (string | null)
  Zip


## Responses
### 200
Successful response

#### Body: application/json (object)
- **about** (string | null)
  About
- **addressLineOne** (string | null)
  Address line one
- **addressLineTwo** (string | null)
  Address line two
- **authenticationSecret** (string | null)
  Authentication secret
- **authenticationToken** (string | null)
  Authentication token
- **city** (string | null)
  City
- **commissionRate** (number | null)
  Commission rate
- **country** (string | null)
  Country
- **createdAt** (string(date-time))
  Created at
- **email** (string)
  Email
- **id** (integer(int32))
  Id
- **iso** (string)
  Iso
- **logo** (string | null)
  Logo
- **name** (string)
  Name
- **orderEndpointUrl** (string | null)
  Order endpoint url
- **phone** (string | null)
  Phone
- **platform** (string)
  Platform
- **referralCode** (string)
  Referral code
- **returnsPolicy** (string | null)
  Returns policy
- **shopifyStoreId** (integer(int32) | null)
  Shopify store
- **sourceType** (string | null)
  Source type
- **state** (string | null)
  State
- **stripeId** (string | null)
  Stripe
- **updatedAt** (string(date-time))
  Updated at
- **welcomeMessage** (string | null)
  Welcome message
- **wooCommerceStoreId** (integer(int32) | null)
  Woo commerce store
- **zip** (string | null)
  Zip


[Powered by Bump.sh](https://bump.sh)