{"id":"ae264a18-5c3e-464c-bb46-bc54a32c22da","createdDate":"2024-10-23T13:42:40.896Z","updatedDate":"2024-10-23T13:42:40.896Z","resourceId":"08334125-1ff0-4f8e-9f03-721ca2a5bb22","api":{"schema":{"object":{"displayName":"Referred Friend Object","description":"","slug":"referred-friend-object","$ref":"#/components/schemas/wix.loyalty.referral.friend.v1.ReferredFriend","legacyExamples":[{"title":"ReferredFriend","content":"{\n \"referredFriend\": {\n \"id\": \"3857d039-b129-4393-b983-947078b6a007\",\n \"contactId\": \"661f5bb3-0723-4aa4-87d7-a21ebd1d0fa3\",\n \"referringCustomerId\": \"07a3306c-b311-466e-92dd-c635c4145d1c\",\n \"status\": \"ACTIONS_COMPLETED\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-08-12T08:12:17.813Z\",\n \"updatedDate\": \"2024-08-12T08:13:27.708Z\"\n }\n}"}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"methods":[{"summary":"Create Referred Friend","description":"Creates a new referred friend or returns an existing entity if it already exists.\n\nThis method must be called with a [member identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#site-members).\n\nA referral code must be provided either in the request or via scope.\n\nThe member must be eligible to become a referred friend.","operationId":"wix.loyalty.referral.friend.v1.ReferredFriends.CreateReferredFriend","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.loyalty.referral.friend.v1.CreateReferredFriendResponse","description":""}},"deprecated":false,"servers":[{"url":"https://manage.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://www.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"www._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://*.dev.wix-code.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://*.pub.wix-code.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"*.pub.wix-code.com","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://editor.wixapps.net/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://editor.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://blocks.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://create.editorx/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"create.editorx","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://_/_api/referral-friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral-friends","destinationPath":"","url":"_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://www.wixapis.com/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/referral_friends","destinationPath":"","url":"www.wixapis.com","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateReferredFriendRequest","description":"","properties":{"referralCode":{"description":"Referral code for the referred friend.","minLength":12,"maxLength":12,"title":"referralCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MEMBER_NOT_ELIGIBLE"}],"exposure":"PUBLIC","maturity":"GA","permissions":["REFERRALS.CREATE_OWN_REFERRED_FRIEND"],"applicableIdentities":["MEMBER"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.loyalty:referral-friends","serviceArtifactId":"com.wixpress.loyalty.referral-friends","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.referral.friend.v1.CreateReferredFriendRequest","responseMessage":"wix.loyalty.referral.friend.v1.CreateReferredFriendResponse"},"legacyExamples":[{"name":"CreateReferredFriend","type":"METHOD","content":{"title":"Create Referred Friend","request":"curl -X POST \\\n 'https://www.wixapis.com/referral_friends/v1/referred-friends' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"referralCode\": \"9zb9JvjwrvQF\"\n }'","response":"{\n \"referredFriend\": {\n \"id\": \"3857d039-b129-4393-b983-947078b6a007\",\n \"contactId\": \"661f5bb3-0723-4aa4-87d7-a21ebd1d0fa3\",\n \"referringCustomerId\": \"07a3306c-b311-466e-92dd-c635c4145d1c\",\n \"status\": \"SIGN_UP_COMPLETED\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-08-12T08:12:17.813Z\",\n \"updatedDate\": \"2024-08-12T08:13:27.708Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/referred-friends","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MEMBER_NOT_ELIGIBLE"}],"exposure":"PUBLIC","maturity":"GA","permissions":["REFERRALS.CREATE_OWN_REFERRED_FRIEND"],"applicableIdentities":["MEMBER"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.loyalty:referral-friends","serviceArtifactId":"com.wixpress.loyalty.referral-friends","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.referral.friend.v1.CreateReferredFriendRequest","responseMessage":"wix.loyalty.referral.friend.v1.CreateReferredFriendResponse"},"legacyExamples":[{"name":"CreateReferredFriend","type":"METHOD","content":{"title":"Create Referred Friend","request":"curl -X POST \\\n 'https://www.wixapis.com/referral_friends/v1/referred-friends' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"referralCode\": \"9zb9JvjwrvQF\"\n }'","response":"{\n \"referredFriend\": {\n \"id\": \"3857d039-b129-4393-b983-947078b6a007\",\n \"contactId\": \"661f5bb3-0723-4aa4-87d7-a21ebd1d0fa3\",\n \"referringCustomerId\": \"07a3306c-b311-466e-92dd-c635c4145d1c\",\n \"status\": \"SIGN_UP_COMPLETED\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-08-12T08:12:17.813Z\",\n \"updatedDate\": \"2024-08-12T08:13:27.708Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Create Referred Friend","slugifiedName":"create-referred-friend"},"permissionScopes":[],"isAdminMethod":false},{"summary":"Get Referred Friend","description":"Retrieves a referred friend by ID.","operationId":"wix.loyalty.referral.friend.v1.ReferredFriends.GetReferredFriend","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"referredFriendId","description":"ID of the referred friend to retrieve.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.loyalty.referral.friend.v1.GetReferredFriendResponse","description":""}},"deprecated":false,"servers":[{"url":"https://manage.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://www.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"www._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://*.dev.wix-code.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://*.pub.wix-code.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"*.pub.wix-code.com","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://editor.wixapps.net/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://editor.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://blocks.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://create.editorx/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"create.editorx","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://_/_api/referral-friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral-friends","destinationPath":"","url":"_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://www.wixapis.com/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/referral_friends","destinationPath":"","url":"www.wixapis.com","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["REFERRALS.READ_REFERRED_FRIENDS"],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.loyalty:referral-friends","serviceArtifactId":"com.wixpress.loyalty.referral-friends","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.referral.friend.v1.GetReferredFriendRequest","responseMessage":"wix.loyalty.referral.friend.v1.GetReferredFriendResponse"},"legacyExamples":[{"name":"GetReferredFriend","type":"METHOD","content":{"title":"Get Referred Friend","request":"curl -X GET \\\n 'https://www.wixapis.com/referral_friends/v1/referred-friends/3857d039-b129-4393-b983-947078b6a007' \\\n -H 'Authorization: '","response":"{\n \"referredFriend\": {\n \"id\": \"3857d039-b129-4393-b983-947078b6a007\",\n \"contactId\": \"661f5bb3-0723-4aa4-87d7-a21ebd1d0fa3\",\n \"referringCustomerId\": \"07a3306c-b311-466e-92dd-c635c4145d1c\",\n \"status\": \"ACTIONS_COMPLETED\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-08-12T08:12:17.813Z\",\n \"updatedDate\": \"2024-08-12T08:13:27.708Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v1/referred-friends/{referredFriendId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["REFERRALS.READ_REFERRED_FRIENDS"],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.loyalty:referral-friends","serviceArtifactId":"com.wixpress.loyalty.referral-friends","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.referral.friend.v1.GetReferredFriendRequest","responseMessage":"wix.loyalty.referral.friend.v1.GetReferredFriendResponse"},"legacyExamples":[{"name":"GetReferredFriend","type":"METHOD","content":{"title":"Get Referred Friend","request":"curl -X GET \\\n 'https://www.wixapis.com/referral_friends/v1/referred-friends/3857d039-b129-4393-b983-947078b6a007' \\\n -H 'Authorization: '","response":"{\n \"referredFriend\": {\n \"id\": \"3857d039-b129-4393-b983-947078b6a007\",\n \"contactId\": \"661f5bb3-0723-4aa4-87d7-a21ebd1d0fa3\",\n \"referringCustomerId\": \"07a3306c-b311-466e-92dd-c635c4145d1c\",\n \"status\": \"ACTIONS_COMPLETED\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-08-12T08:12:17.813Z\",\n \"updatedDate\": \"2024-08-12T08:13:27.708Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Referred Friend","slugifiedName":"get-referred-friend"},"permissionScopes":[],"isAdminMethod":true},{"summary":"Delete Referred Friend","description":"Deletes a referred friend.","operationId":"wix.loyalty.referral.friend.v1.ReferredFriends.DeleteReferredFriend","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"referredFriendId","description":"ID of the referred friend to delete.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"revision","in":"query","description":"Revision number, which increments by 1 each time the referred friend is updated.\nTo prevent conflicting changes, the current revision must be passed when deleting the referred friend.","required":false,"schema":{"description":"Revision number, which increments by 1 each time the referred friend is updated.\nTo prevent conflicting changes, the current revision must be passed when deleting the referred friend.","title":"revision","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.loyalty.referral.friend.v1.DeleteReferredFriendResponse","description":""}},"deprecated":false,"servers":[{"url":"https://manage.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://www.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"www._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://*.dev.wix-code.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://*.pub.wix-code.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"*.pub.wix-code.com","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://editor.wixapps.net/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://editor.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://blocks.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://create.editorx/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"create.editorx","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://_/_api/referral-friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral-friends","destinationPath":"","url":"_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://www.wixapis.com/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/referral_friends","destinationPath":"","url":"www.wixapis.com","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Referred Friend Deleted","description":"Triggered when a referred friend is deleted.","permissions":["REFERRALS.MANAGE_REFERRED_FRIENDS"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.loyalty.referral.v1.referred_friend","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.loyalty.referral.v1.referred_friend_deleted","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["REFERRALS.MANAGE_REFERRED_FRIENDS"],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.loyalty:referral-friends","serviceArtifactId":"com.wixpress.loyalty.referral-friends","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.referral.friend.v1.DeleteReferredFriendRequest","responseMessage":"wix.loyalty.referral.friend.v1.DeleteReferredFriendResponse"},"legacyExamples":[{"name":"DeleteReferredFriend","type":"METHOD","content":{"title":"Delete Referred Friend","request":"curl -X DELETE \\\n 'https://www.wixapis.com/referral_friends/v1/referred-friends/3857d039-b129-4393-b983-947078b6a007' \\\n -H 'Authorization: '","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"delete","path":"/v1/referred-friends/{referredFriendId}","rpcOnly":false,"triggeredEvents":[{"title":"Referred Friend Deleted","description":"Triggered when a referred friend is deleted.","permissions":["REFERRALS.MANAGE_REFERRED_FRIENDS"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.loyalty.referral.v1.referred_friend","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.loyalty.referral.v1.referred_friend_deleted","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["REFERRALS.MANAGE_REFERRED_FRIENDS"],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.loyalty:referral-friends","serviceArtifactId":"com.wixpress.loyalty.referral-friends","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.referral.friend.v1.DeleteReferredFriendRequest","responseMessage":"wix.loyalty.referral.friend.v1.DeleteReferredFriendResponse"},"legacyExamples":[{"name":"DeleteReferredFriend","type":"METHOD","content":{"title":"Delete Referred Friend","request":"curl -X DELETE \\\n 'https://www.wixapis.com/referral_friends/v1/referred-friends/3857d039-b129-4393-b983-947078b6a007' \\\n -H 'Authorization: '","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Delete Referred Friend","slugifiedName":"delete-referred-friend"},"permissionScopes":[],"isAdminMethod":true},{"summary":"Get Referred Friend By Contact Id","description":"Retrieves a referred friend by contact ID.\n\nYou can use `me` instead of a specific contact ID to get the referred friend for the current identity's contact.","operationId":"wix.loyalty.referral.friend.v1.ReferredFriends.GetReferredFriendByContactId","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"contactId","description":"Contact ID or \"me\" to get the current identity's contact.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.loyalty.referral.friend.v1.GetReferredFriendByContactIdResponse","description":""}},"deprecated":false,"servers":[{"url":"https://manage.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://www.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"www._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://*.dev.wix-code.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://*.pub.wix-code.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"*.pub.wix-code.com","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://editor.wixapps.net/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://editor.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://blocks.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://create.editorx/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"create.editorx","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://_/_api/referral-friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral-friends","destinationPath":"","url":"_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://www.wixapis.com/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/referral_friends","destinationPath":"","url":"www.wixapis.com","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["REFERRALS.READ_REFERRED_FRIENDS"],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.loyalty:referral-friends","serviceArtifactId":"com.wixpress.loyalty.referral-friends","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.referral.friend.v1.GetReferredFriendByContactIdRequest","responseMessage":"wix.loyalty.referral.friend.v1.GetReferredFriendByContactIdResponse"},"legacyExamples":[{"name":"GetReferredFriendByContactId","type":"METHOD","content":{"title":"Get Referred Friend by Contact Id","request":"curl -X GET \\\n 'https://www.wixapis.com/referral_friends/v1/referred-friends/contact/me?contactId=me' \\\n -H 'Authorization: '","response":"{\n \"referredFriend\": {\n \"id\": \"3857d039-b129-4393-b983-947078b6a007\",\n \"contactId\": \"661f5bb3-0723-4aa4-87d7-a21ebd1d0fa3\",\n \"referringCustomerId\": \"07a3306c-b311-466e-92dd-c635c4145d1c\",\n \"status\": \"ACTIONS_COMPLETED\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-08-12T08:12:17.813Z\",\n \"updatedDate\": \"2024-08-12T08:13:27.708Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v1/referred-friends/contact/{contactId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["REFERRALS.READ_REFERRED_FRIENDS"],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.loyalty:referral-friends","serviceArtifactId":"com.wixpress.loyalty.referral-friends","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.referral.friend.v1.GetReferredFriendByContactIdRequest","responseMessage":"wix.loyalty.referral.friend.v1.GetReferredFriendByContactIdResponse"},"legacyExamples":[{"name":"GetReferredFriendByContactId","type":"METHOD","content":{"title":"Get Referred Friend by Contact Id","request":"curl -X GET \\\n 'https://www.wixapis.com/referral_friends/v1/referred-friends/contact/me?contactId=me' \\\n -H 'Authorization: '","response":"{\n \"referredFriend\": {\n \"id\": \"3857d039-b129-4393-b983-947078b6a007\",\n \"contactId\": \"661f5bb3-0723-4aa4-87d7-a21ebd1d0fa3\",\n \"referringCustomerId\": \"07a3306c-b311-466e-92dd-c635c4145d1c\",\n \"status\": \"ACTIONS_COMPLETED\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-08-12T08:12:17.813Z\",\n \"updatedDate\": \"2024-08-12T08:13:27.708Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Referred Friend By Contact Id","slugifiedName":"get-referred-friend-by-contact-id"},"permissionScopes":[],"isAdminMethod":true},{"summary":"Update Referred Friend","description":"Updates a referred friend. Supports partial updates.\n\nYou must pass the latest `revision` for a successful update.","operationId":"wix.loyalty.referral.friend.v1.ReferredFriends.UpdateReferredFriend","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"referredFriend.id","description":"ID of the referred friend.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.loyalty.referral.friend.v1.UpdateReferredFriendResponse","description":""}},"deprecated":false,"servers":[{"url":"https://manage.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://www.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"www._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://*.dev.wix-code.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://*.pub.wix-code.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"*.pub.wix-code.com","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://editor.wixapps.net/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://editor.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://blocks.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://create.editorx/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"create.editorx","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://_/_api/referral-friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral-friends","destinationPath":"","url":"_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://www.wixapis.com/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/referral_friends","destinationPath":"","url":"www.wixapis.com","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateReferredFriendRequest","description":"","properties":{"referredFriend":{"description":"Referred friend to be updated. May be partial.","$ref":"#/components/schemas/wix.loyalty.referral.friend.v1.ReferredFriend","summary":"referredFriend","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["referredFriend","referredFriend.id","referredFriend.revision"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Referred Friend Updated","description":"Triggered when a referred friend is updated.","permissions":["REFERRALS.MANAGE_REFERRED_FRIENDS"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.referral.v1.referred_friend","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.loyalty.referral.v1.referred_friend_updated","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["REFERRALS.MANAGE_REFERRED_FRIENDS"],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.loyalty:referral-friends","serviceArtifactId":"com.wixpress.loyalty.referral-friends","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.referral.friend.v1.UpdateReferredFriendRequest","responseMessage":"wix.loyalty.referral.friend.v1.UpdateReferredFriendResponse"},"legacyExamples":[{"name":"UpdateReferredFriend","type":"METHOD","content":{"title":"Update Referred Friend","request":"curl -X PATCH \\\n 'https://www.wixapis.com/referral_friends/v1/referred-friends/3857d039-b129-4393-b983-947078b6a007' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"referredFriend\": {\n \"id\": \"3857d039-b129-4393-b983-947078b6a007\",\n \"status\": \"ACTIONS_COMPLETED\",\n \"revision\": \"2\"\n }\n }'","response":"{\n \"referredFriend\": {\n \"id\": \"3857d039-b129-4393-b983-947078b6a007\",\n \"contactId\": \"661f5bb3-0723-4aa4-87d7-a21ebd1d0fa3\",\n \"referringCustomerId\": \"07a3306c-b311-466e-92dd-c635c4145d1c\",\n \"status\": \"SIGN_UP_COMPLETED\",\n \"revision\": \"3\",\n \"createdDate\": \"2024-08-12T08:12:17.813Z\",\n \"updatedDate\": \"2024-08-12T08:13:27.708Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"patch","path":"/v1/referred-friends/{referredFriend.id}","rpcOnly":false,"triggeredEvents":[{"title":"Referred Friend Updated","description":"Triggered when a referred friend is updated.","permissions":["REFERRALS.MANAGE_REFERRED_FRIENDS"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.referral.v1.referred_friend","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.loyalty.referral.v1.referred_friend_updated","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["REFERRALS.MANAGE_REFERRED_FRIENDS"],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.loyalty:referral-friends","serviceArtifactId":"com.wixpress.loyalty.referral-friends","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.referral.friend.v1.UpdateReferredFriendRequest","responseMessage":"wix.loyalty.referral.friend.v1.UpdateReferredFriendResponse"},"legacyExamples":[{"name":"UpdateReferredFriend","type":"METHOD","content":{"title":"Update Referred Friend","request":"curl -X PATCH \\\n 'https://www.wixapis.com/referral_friends/v1/referred-friends/3857d039-b129-4393-b983-947078b6a007' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"referredFriend\": {\n \"id\": \"3857d039-b129-4393-b983-947078b6a007\",\n \"status\": \"ACTIONS_COMPLETED\",\n \"revision\": \"2\"\n }\n }'","response":"{\n \"referredFriend\": {\n \"id\": \"3857d039-b129-4393-b983-947078b6a007\",\n \"contactId\": \"661f5bb3-0723-4aa4-87d7-a21ebd1d0fa3\",\n \"referringCustomerId\": \"07a3306c-b311-466e-92dd-c635c4145d1c\",\n \"status\": \"SIGN_UP_COMPLETED\",\n \"revision\": \"3\",\n \"createdDate\": \"2024-08-12T08:12:17.813Z\",\n \"updatedDate\": \"2024-08-12T08:13:27.708Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Update Referred Friend","slugifiedName":"update-referred-friend"},"permissionScopes":[],"isAdminMethod":true},{"summary":"Query Referred Friend","description":"Retrieves a list of referred friends, given the provided paging, filtering, and sorting.\n\nThis endpoint supports [WQL (Wix Query Language)](https://dev.wix.com/api/rest/getting-started/api-query-language).\n\nTo learn about working with _Query_ endpoints, see\n[API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),\nand [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).","operationId":"wix.loyalty.referral.friend.v1.ReferredFriends.QueryReferredFriend","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.loyalty.referral.friend.v1.QueryReferredFriendResponse","description":""}},"deprecated":false,"servers":[{"url":"https://manage.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://www.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"www._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://*.dev.wix-code.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://*.pub.wix-code.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"*.pub.wix-code.com","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://editor.wixapps.net/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"editor.wixapps.net","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://editor.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"editor._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://blocks.wix.com/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"blocks._base_domain_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://create.editorx/_api/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral_friends","destinationPath":"","url":"create.editorx","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://_/_api/referral-friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/referral-friends","destinationPath":"","url":"_","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}},{"url":"https://www.wixapis.com/referral_friends","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/referral_friends","destinationPath":"","url":"www.wixapis.com","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryReferredFriendRequest","description":"","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/wix.common.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["query"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["REFERRALS.READ_REFERRED_FRIENDS"],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.loyalty:referral-friends","serviceArtifactId":"com.wixpress.loyalty.referral-friends","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.referral.friend.v1.QueryReferredFriendRequest","responseMessage":"wix.loyalty.referral.friend.v1.QueryReferredFriendResponse"},"legacyExamples":[{"name":"QueryReferredFriend","type":"METHOD","content":{"title":"Query Referred Friend","request":"curl -X POST \\\n 'https://www.wixapis.com/referral_friends/v1/referred-friends/query' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"query\": {\n \"sort\": [\n {\n \"order\": \"DESC\",\n \"fieldName\": \"revision\"\n }\n ],\n \"filter\": {\n \"status\": \"ACTIONS_COMPLETED\"\n }\n }\n }'","response":"{\n \"referredFriends\": [\n {\n \"id\": \"3857d039-b129-4393-b983-947078b6a007\",\n \"contactId\": \"661f5bb3-0723-4aa4-87d7-a21ebd1d0fa3\",\n \"referringCustomerId\": \"07a3306c-b311-466e-92dd-c635c4145d1c\",\n \"status\": \"ACTIONS_COMPLETED\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-08-12T08:12:17.813Z\",\n \"updatedDate\": \"2024-08-12T08:13:27.708Z\"\n }\n ],\n \"metadata\": {\n \"count\": 1,\n \"cursors\": {\n \"next\": null,\n \"prev\": null\n },\n \"hasNext\": false,\n \"total\": null\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/referred-friends/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["REFERRALS.READ_REFERRED_FRIENDS"],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.loyalty:referral-friends","serviceArtifactId":"com.wixpress.loyalty.referral-friends","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.loyalty.referral.friend.v1.QueryReferredFriendRequest","responseMessage":"wix.loyalty.referral.friend.v1.QueryReferredFriendResponse"},"legacyExamples":[{"name":"QueryReferredFriend","type":"METHOD","content":{"title":"Query Referred Friend","request":"curl -X POST \\\n 'https://www.wixapis.com/referral_friends/v1/referred-friends/query' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"query\": {\n \"sort\": [\n {\n \"order\": \"DESC\",\n \"fieldName\": \"revision\"\n }\n ],\n \"filter\": {\n \"status\": \"ACTIONS_COMPLETED\"\n }\n }\n }'","response":"{\n \"referredFriends\": [\n {\n \"id\": \"3857d039-b129-4393-b983-947078b6a007\",\n \"contactId\": \"661f5bb3-0723-4aa4-87d7-a21ebd1d0fa3\",\n \"referringCustomerId\": \"07a3306c-b311-466e-92dd-c635c4145d1c\",\n \"status\": \"ACTIONS_COMPLETED\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-08-12T08:12:17.813Z\",\n \"updatedDate\": \"2024-08-12T08:13:27.708Z\"\n }\n ],\n \"metadata\": {\n \"count\": 1,\n \"cursors\": {\n \"next\": null,\n \"prev\": null\n },\n \"hasNext\": false,\n \"total\": null\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Query Referred Friend","slugifiedName":"query-referred-friend"},"permissionScopes":[],"isAdminMethod":true}],"webhooks":[{"summary":"Referred Friend Created","title":"Referred Friend Created","description":"Triggered when a referred friend is created.","permissions":["REFERRALS.READ_REFERRED_FRIENDS"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.loyalty.referral.v1.referred_friend","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.loyalty.referral.v1.referred_friend_created","legacyExamples":[{"name":"ReferredFriendCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"9aca3895-8c58-48b7-84a5-35bcd431c125\",\n \"entityFqdn\": \"wix.loyalty.referral.v1.referred_friend\",\n \"slug\": \"created\",\n \"entityId\": \"aaf51c30-a61c-473e-96be-a42dfa5064c0\",\n \"eventTime\": \"2024-08-12T08:12:17.813Z\",\n \"createdEvent\": {\n \"entity\": {\n \"id\": \"3857d039-b129-4393-b983-947078b6a007\",\n \"contactId\": \"661f5bb3-0723-4aa4-87d7-a21ebd1d0fa3\",\n \"referringCustomerId\": \"07a3306c-b311-466e-92dd-c635c4145d1c\",\n \"status\": \"ACTIONS_COMPLETED\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-08-12T08:12:17.813Z\",\n \"updatedDate\": \"2024-08-12T08:13:27.708Z\"\n }\n }\n}"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/wix.loyalty.referral.friend.v1.ReferredFriend","contentLink":{"displayName":"Referred Friend Created","slugifiedName":"referred-friend-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]},{"summary":"Referred Friend Updated","title":"Referred Friend Updated","description":"Triggered when a referred friend is updated.","permissions":["REFERRALS.MANAGE_REFERRED_FRIENDS"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.referral.v1.referred_friend","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.loyalty.referral.v1.referred_friend_updated","legacyExamples":[{"name":"ReferredFriendUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"9aca3895-8c58-48b7-84a5-35bcd431c125\",\n \"entityFqdn\": \"wix.loyalty.referral.v1.referred_friend\",\n \"slug\": \"updated\",\n \"entityId\": \"aaf51c30-a61c-473e-96be-a42dfa5064c0\",\n \"eventTime\": \"2024-08-12T08:12:17.813Z\",\n \"updatedEvent\": {\n \"currentEntity\": {\n \"id\": \"3857d039-b129-4393-b983-947078b6a007\",\n \"contactId\": \"661f5bb3-0723-4aa4-87d7-a21ebd1d0fa3\",\n \"referringCustomerId\": \"07a3306c-b311-466e-92dd-c635c4145d1c\",\n \"status\": \"ACTIONS_COMPLETED\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-08-12T08:12:17.813Z\",\n \"updatedDate\": \"2024-08-12T08:13:27.708Z\"\n }\n }\n}"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/wix.loyalty.referral.friend.v1.ReferredFriend","contentLink":{"displayName":"Referred Friend Updated","slugifiedName":"referred-friend-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]},{"summary":"Referred Friend Deleted","title":"Referred Friend Deleted","description":"Triggered when a referred friend is deleted.","permissions":["REFERRALS.MANAGE_REFERRED_FRIENDS"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.loyalty.referral.v1.referred_friend","serviceName":"wix.loyalty.referral.friend.v1.ReferredFriends","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.loyalty.referral.v1.referred_friend_deleted","legacyExamples":[{"name":"ReferredFriendDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"9aca3895-8c58-48b7-84a5-35bcd431c125\",\n \"entityFqdn\": \"wix.loyalty.referral.v1.referred_friend\",\n \"slug\": \"deleted\",\n \"entityId\": \"aaf51c30-a61c-473e-96be-a42dfa5064c0\",\n \"deletedEvent\": {},\n \"eventTime\": \"2024-08-12T08:12:17.813Z\",\n \"triggeredByAnonymizeRequest\": true\n}"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/wix.loyalty.referral.friend.v1.ReferredFriend","contentLink":{"displayName":"Referred Friend Deleted","slugifiedName":"referred-friend-deleted"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Introduction\n\nThe Referred Friend API allows you to manage referred friends in your referral program on your Wix site.\n\nWith the Referred Friend API, you can:\n\n+ [Create a referred friend](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::08334125-1ff0-4f8e-9f03-721ca2a5bb22slug::create-referred-friend*fallback::https://dev.wix.com/docs/rest/business-management/marketing/referral-program/referred-friend/create-referred-friend) to add new participants to your referral program.\n+ [Get a referred friend](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::08334125-1ff0-4f8e-9f03-721ca2a5bb22slug::get-referred-friend*fallback::https://dev.wix.com/docs/rest/business-management/marketing/referral-program/referred-friend/get-referred-friend) to retrieve details about a specific referred friend.\n+ [Get a referred friend by contact ID](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::08334125-1ff0-4f8e-9f03-721ca2a5bb22slug::get-referred-friend-by-contact-id*fallback::https://dev.wix.com/docs/rest/business-management/marketing/referral-program/referred-friend/get-referred-friend-by-contact-id) to find a referred friend using their contact information.\n+ [Update a referred friend](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::08334125-1ff0-4f8e-9f03-721ca2a5bb22slug::update-referred-friend*fallback::https://dev.wix.com/docs/rest/business-management/marketing/referral-program/referred-friend/update-referred-friend) to modify information about an existing referred friend.\n+ [Delete a referred friend](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::08334125-1ff0-4f8e-9f03-721ca2a5bb22slug::delete-referred-friend*fallback::https://dev.wix.com/docs/rest/business-management/marketing/referral-program/referred-friend/delete-referred-friend) to remove a referred friend from your program.\n+ [Query referred friends](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::08334125-1ff0-4f8e-9f03-721ca2a5bb22slug::query-referred-friend*fallback::https://dev.wix.com/docs/rest/business-management/marketing/referral-program/referred-friend/query-referred-friend) to search for and retrieve multiple referred friends based on specific criteria.\n\n## Before you begin\n\nIt's important to note the following points before starting to code:\n\n- The Referred Friend API requires a Business or higher plan for Wix Editor, or a Plus or higher plan for Wix Studio.\n- You must have at least one of these apps installed: Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans, or the new Wix Restaurants ordering app.\n\n## Terminology\n\n- **Referred Friend**: A person who clicks on a referral URL shared by a referring customer.\n- **Referring Customer**: A site member who shares a referral URL with potential new customers.\n- **Referral Code**: A unique code assigned to a referring customer.\n- **Referral Program**: A feature that allows your site members to refer friends to your business by sharing referral URLs. You have the option to reward both the customer doing the referring and the friend being referred.\n- **Status**: The current state of a referred friend in the referral program (for example, `SIGN_UP_COMPLETED`, `ACTIONS_COMPLETED`).\n"},{"displayName":"Filter and Sort","slugifyName":"filter-and-sort","content":"# Referred Friend: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting for the Referred Friend object:\n\n| Field | Query Filter Operators | Sortable |\n|-------------------------|------------------------------------------------------------------------------------|----------|\n| `referringCustomerId` | `$eq`, `$ne`, `$hasSome`, `$startsWith`, `$in`, `$nin`, `$exists` | Sortable |\n| `status` | `$eq`, `$ne`, `$hasSome`, `$startsWith`, `$in`, `$nin`, `$exists` | Sortable |\n| `createdDate` | `$eq`, `$ne`, `$hasSome`, `$in`, `$nin`, `$exists`, `$lt`, `$lte`, `$gt`, `$gte` | Sortable |\n| `updatedDate` | `$eq`, `$ne`, `$hasSome`, `$in`, `$nin`, `$exists`, `$lt`, `$lte`, `$gt`, `$gte` | Sortable |\n\n__Related content:__\n[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Query Referred Friend endpoint](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::08334125-1ff0-4f8e-9f03-721ca2a5bb22slug::query-referred-friend*fallback::https://dev.wix.com/docs/rest/business-management/marketing/referral-program/referred-friend/query-referred-friend)"}],"components":{"schemas":{"wix.loyalty.referral.friend.v1.ReferredFriend":{"type":"object","properties":{"id":{"description":"ID of the referred friend.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contactId":{"description":"Contact ID of the referred friend.","format":"GUID","readOnly":true,"title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringCustomerId":{"description":"ID of the customer who referred this friend.","format":"GUID","readOnly":true,"title":"referringCustomerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Status of the referred friend.","title":"status","type":"string","$ref":"#/components/schemas/wix.loyalty.referral.friend.v1.ReferredFriend.Status","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the referred friend is updated.\nTo prevent conflicting changes, the current revision must be passed when updating the referred friend.","readOnly":true,"immutable":true,"title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the referred friend was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the referred friend was last updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReferredFriend","description":""},"wix.loyalty.referral.friend.v1.ReferredFriend.Status":{"type":"string","description":"","title":"Status","enum":[{"order":0,"value":"UNKNOWN","description":"Unknown status.","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"SIGN_UP_COMPLETED","description":"Initial status when the referred friend joins the site as a member.","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"ACTIONS_COMPLETED","description":"Status after the referred friend completes specific actions, such as making a purchase.","maturity":"GA","exposure":"PUBLIC"}]},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"wix.loyalty.referral.friend.v1.CreateReferredFriendRequest":{"type":"object","properties":{"referralCode":{"description":"Referral code for the referred friend.","minLength":12,"maxLength":12,"title":"referralCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateReferredFriendRequest","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"wix.loyalty.referral.friend.v1.CreateReferredFriendResponse":{"type":"object","properties":{"referredFriend":{"description":"Created referred friend.","$ref":"#/components/schemas/wix.loyalty.referral.friend.v1.ReferredFriend","summary":"referredFriend","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateReferredFriendResponse","description":""},"wix.loyalty.referral.friend.v1.GetReferredFriendRequest":{"type":"object","properties":{"referredFriendId":{"description":"ID of the referred friend to retrieve.","format":"GUID","title":"referredFriendId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetReferredFriendRequest","description":""},"wix.loyalty.referral.friend.v1.GetReferredFriendResponse":{"type":"object","properties":{"referredFriend":{"description":"Retrieved referred friend.","$ref":"#/components/schemas/wix.loyalty.referral.friend.v1.ReferredFriend","summary":"referredFriend","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetReferredFriendResponse","description":""},"wix.loyalty.referral.friend.v1.GetReferredFriendByContactIdRequest":{"type":"object","properties":{"contactId":{"description":"Contact ID or \"me\" to get the current identity's contact.","minLength":2,"title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetReferredFriendByContactIdRequest","description":""},"wix.loyalty.referral.friend.v1.GetReferredFriendByContactIdResponse":{"type":"object","properties":{"referredFriend":{"description":"Retrieved referred friend.","$ref":"#/components/schemas/wix.loyalty.referral.friend.v1.ReferredFriend","summary":"referredFriend","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetReferredFriendByContactIdResponse","description":""},"wix.loyalty.referral.friend.v1.UpdateReferredFriendRequest":{"type":"object","properties":{"referredFriend":{"description":"Referred friend to be updated. May be partial.","$ref":"#/components/schemas/wix.loyalty.referral.friend.v1.ReferredFriend","summary":"referredFriend","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateReferredFriendRequest","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"description":"","title":"paths","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FieldMask","description":""},"wix.loyalty.referral.friend.v1.UpdateReferredFriendResponse":{"type":"object","properties":{"referredFriend":{"description":"Updated referred friend.","$ref":"#/components/schemas/wix.loyalty.referral.friend.v1.ReferredFriend","summary":"referredFriend","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateReferredFriendResponse","description":""},"wix.loyalty.referral.friend.v1.DeleteReferredFriendRequest":{"type":"object","properties":{"referredFriendId":{"description":"ID of the referred friend to delete.","format":"GUID","title":"referredFriendId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the referred friend is updated.\nTo prevent conflicting changes, the current revision must be passed when deleting the referred friend.","title":"revision","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteReferredFriendRequest","description":""},"wix.loyalty.referral.friend.v1.DeleteReferredFriendResponse":{"type":"object","properties":{},"title":"DeleteReferredFriendResponse","description":""},"wix.loyalty.referral.friend.v1.QueryReferredFriendRequest":{"type":"object","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/wix.common.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryReferredFriendRequest","description":""},"wix.common.CursorQuery":{"type":"object","properties":{"filter":{"description":"Filter object.\n\nLearn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object.\n\nLearn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).","maxItems":5,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorQuery","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/wix.common.CursorQuery.pagingMethod"}]},"wix.common.CursorQuery.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"cursorPaging":{"description":"Cursor paging options.\n\nLearn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).","$ref":"#/components/schemas/wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":[{"order":0,"value":"NULL_VALUE","description":"","maturity":"GA","exposure":"PUBLIC"}]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","maxLength":512,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":[{"order":0,"value":"ASC","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"DESC","description":"","maturity":"GA","exposure":"PUBLIC"}]},"wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Maximum number of items to return in the results.","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","maxLength":16000,"title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"wix.loyalty.referral.friend.v1.QueryReferredFriendResponse":{"type":"object","properties":{"referredFriends":{"description":"Retrieved referred friends.","title":"referredFriends","type":"array","items":{"$ref":"#/components/schemas/wix.loyalty.referral.friend.v1.ReferredFriend"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"Cursor paging metadata.","$ref":"#/components/schemas/wix.common.CursorPagingMetadata","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryReferredFriendResponse","description":""},"wix.common.CursorPagingMetadata":{"type":"object","properties":{"count":{"description":"Number of items returned in current page.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursor strings that point to the next page, previous page, or both.","$ref":"#/components/schemas/wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hasNext":{"description":"Whether there are more pages to retrieve following the current page.\n\n+ `true`: Another page of results can be retrieved.\n+ `false`: This is the last page.","title":"hasNext","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPagingMetadata","description":""},"wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor string pointing to the next page in the list of results.","maxLength":16000,"title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to the previous page in the list of results.","maxLength":16000,"title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"restoreInfo":{"description":"Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity","$ref":"#/components/schemas/wix.common.domainevents.RestoreInfo","summary":"restoreInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.RestoreInfo":{"type":"object","properties":{"deletedDate":{"description":"","title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreInfo","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"wix.loyalty.referral.action.v1.SuccessfulReferralEvent":{"type":"object","properties":{"referredFriendDetails":{"description":"Details of the referred friend who completed their referral.","$ref":"#/components/schemas/wix.loyalty.referral.action.v1.ReferredFriendDetails","summary":"referredFriendDetails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SuccessfulReferralEvent","description":""},"wix.loyalty.referral.action.v1.ReferredFriendDetails":{"type":"object","properties":{"referredFriendId":{"description":"ID of the referred friend.","format":"GUID","readOnly":true,"title":"referredFriendId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contactId":{"description":"Contact ID of the referred friend.","format":"GUID","readOnly":true,"title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringCustomerId":{"description":"ID of the customer who referred this friend.","format":"GUID","readOnly":true,"title":"referringCustomerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReferredFriendDetails","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":[{"order":0,"value":"UNKNOWN","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"ANONYMOUS_VISITOR","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"MEMBER","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"WIX_USER","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":4,"value":"APP","description":"","maturity":"GA","exposure":"PUBLIC"}]}}},"title":"Referred Friend","description":"","fqdn":"wix.loyalty.referral.v1.referred_friend"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Introduction\n\nThe Referred Friend API allows you to manage referred friends in your referral program on your Wix site.\n\nWith the Referred Friend API, you can:\n\n+ [Create a referred friend](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::08334125-1ff0-4f8e-9f03-721ca2a5bb22slug::create-referred-friend*fallback::https://dev.wix.com/docs/rest/business-management/marketing/referral-program/referred-friend/create-referred-friend) to add new participants to your referral program.\n+ [Get a referred friend](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::08334125-1ff0-4f8e-9f03-721ca2a5bb22slug::get-referred-friend*fallback::https://dev.wix.com/docs/rest/business-management/marketing/referral-program/referred-friend/get-referred-friend) to retrieve details about a specific referred friend.\n+ [Get a referred friend by contact ID](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::08334125-1ff0-4f8e-9f03-721ca2a5bb22slug::get-referred-friend-by-contact-id*fallback::https://dev.wix.com/docs/rest/business-management/marketing/referral-program/referred-friend/get-referred-friend-by-contact-id) to find a referred friend using their contact information.\n+ [Update a referred friend](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::08334125-1ff0-4f8e-9f03-721ca2a5bb22slug::update-referred-friend*fallback::https://dev.wix.com/docs/rest/business-management/marketing/referral-program/referred-friend/update-referred-friend) to modify information about an existing referred friend.\n+ [Delete a referred friend](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::08334125-1ff0-4f8e-9f03-721ca2a5bb22slug::delete-referred-friend*fallback::https://dev.wix.com/docs/rest/business-management/marketing/referral-program/referred-friend/delete-referred-friend) to remove a referred friend from your program.\n+ [Query referred friends](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::08334125-1ff0-4f8e-9f03-721ca2a5bb22slug::query-referred-friend*fallback::https://dev.wix.com/docs/rest/business-management/marketing/referral-program/referred-friend/query-referred-friend) to search for and retrieve multiple referred friends based on specific criteria.\n\n## Before you begin\n\nIt's important to note the following points before starting to code:\n\n- The Referred Friend API requires a Business or higher plan for Wix Editor, or a Plus or higher plan for Wix Studio.\n- You must have at least one of these apps installed: Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans, or the new Wix Restaurants ordering app.\n\n## Terminology\n\n- **Referred Friend**: A person who clicks on a referral URL shared by a referring customer.\n- **Referring Customer**: A site member who shares a referral URL with potential new customers.\n- **Referral Code**: A unique code assigned to a referring customer.\n- **Referral Program**: A feature that allows your site members to refer friends to your business by sharing referral URLs. You have the option to reward both the customer doing the referring and the friend being referred.\n- **Status**: The current state of a referred friend in the referral program (for example, `SIGN_UP_COMPLETED`, `ACTIONS_COMPLETED`).\n"},{"displayName":"Filter and Sort","slugifyName":"filter-and-sort","content":"# Referred Friend: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting for the Referred Friend object:\n\n| Field | Query Filter Operators | Sortable |\n|-------------------------|------------------------------------------------------------------------------------|----------|\n| `referringCustomerId` | `$eq`, `$ne`, `$hasSome`, `$startsWith`, `$in`, `$nin`, `$exists` | Sortable |\n| `status` | `$eq`, `$ne`, `$hasSome`, `$startsWith`, `$in`, `$nin`, `$exists` | Sortable |\n| `createdDate` | `$eq`, `$ne`, `$hasSome`, `$in`, `$nin`, `$exists`, `$lt`, `$lte`, `$gt`, `$gte` | Sortable |\n| `updatedDate` | `$eq`, `$ne`, `$hasSome`, `$in`, `$nin`, `$exists`, `$lt`, `$lte`, `$gt`, `$gte` | Sortable |\n\n__Related content:__\n[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Query Referred Friend endpoint](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::08334125-1ff0-4f8e-9f03-721ca2a5bb22slug::query-referred-friend*fallback::https://dev.wix.com/docs/rest/business-management/marketing/referral-program/referred-friend/query-referred-friend)"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}