Creates new recipient for preferred gift

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

allow_duplicates

boolean

Defaults to true

Set to false to prevent creating a new recipient if one already exists with the same email address

recipient_name

string

recipient_email

string

Email address of the recipient. Required unless send_email is false. When provided with send_email false, the email is stored on the recipient but no email is sent

send_email

boolean

Defaults to true

Set to false to generate a unique recipient link without Brilliant sending the invitation email. The created recipient's URL is returned in the response as recipient_url

sender_name

string

Sets the name that will be shown as the person who sent the PG to the recipient

sender_email

string

Sets the email associated with the person who is sending the PG to the recipient

external_id

string

store_user_id

int64

The id of the Brilliant store user sending this Preferred Gift to the recipient. Used to attribute the resulting order to the store user who originated it

origin_external_solution_instance_id

string

allow_duplicate_external_entity

boolean

Defaults to true

Set to false to prevent creating a new recipient associated with the same external ID

duplicate_lookback

integer | null

Number of days to look back when checking for duplicate recipients or external entities. If absent, blank or less than 1, duplicates are checked over the lifetime of the PG

201Created

404Not Found

422Inactive Record