Adds a friend by creating a member friend using a friend code

Licenses Required

  • Vista.Ocapi
  • Vista.Loyalty.Friends
Request
header Parameters
loyaltySessionToken
string

Current Loyalty session token, represents a 'signed-in' member

Connect-Region-Code
string

Region Code

Request Body schema:
required

The values needed to create the member friend

friendCode
required
string non-empty

Gets the member friend code FriendCode

Responses
200

Success

400

Request property is invalid or missing, or member cannot add friend.

401

No member authenticated.

429

Too many requests. Try again later.

post/ocapi/v1/members/current/friends/code
Request samples
{
  • "friendCode": "string"
}
Response samples
application/json
{
  • "friend": {
    },
  • "relatedData": {
    }
}