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

Licenses Required

Vista.Ocapi
Vista.Loyalty.Friends

post/ocapi/v1/members/current/friends/code

Request

Base URL
https://developer.vista.co (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/vista/apis/vista-digital-platform/docs/ocapi/v1/members/current/friends/code/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

loyaltySessionTokenstring

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

Connect-Region-Codestring

Region Code

Request body

friendCodestring required

Gets the member friend code FriendCode

Response

Success

Example response

{
  "relatedData": {
    "subscriptions": [
      {
        "name": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        }
      }
    ]
  }
}

Changes

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