Subscription Recipient

patch

https://app.financekey.com/OData/v_SubscriptionRecipients({key})

The SubscriptionRecipient table contains data related to the people that receive a subscription from the Subscription package. This table stores information such as the person's name, email address, preferences, and subscription status. It also stores the date and time of when the subscription was created, as well as any other pertinent information related to the subscription.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

contactId

int32

ContactId is an integer field in the SubscriptionRecipient table that uniquely identifies a contact within the table. This primary key is required to uniquely identify each individual contact, and ensure data integrity.

lastname

string

required

length ≥ 1

The Lastname field stores the surname of the recipient of a subscription in a table named SubscriptionRecipient. The data type of this field is nvarchar.

firstname

string

required

length ≥ 1

The Firstname field of data type NVARCHAR in the SubscriptionRecipient table is used to store the first name of each recipient in the subscription service.

string

required

length ≥ 1

The Email field in the SubscriptionRecipient table is an NVARCHAR data type used to store the email address of the recipient of a subscription.

name

string | null

The Name of data type nvarchar in SubscriptionRecipient table is a character varying data type used to store characters ranging from 1 to 4,000. It is commonly used to store names of recipients of a subscription service.

description

string | null

The Description field of the SubscriptionRecipient table is an nvarchar data type and is used to store a description about a particular subscription recipient. This may include their contact details, thoughts about their reasons for subscribing, any relevant notes about their subscription, or anything else that may help identify the individual on the subscription list.

parentId

string | null

The ParentId field in the SubscriptionRecipient table is a nvarchar data type with a maximum length of 450. This field is used to define a subscription recipient who is also a child or dependent of an existing subscription recipient. The ParentId stores a unique identifier for the parent/guardian recipient.

personId

int32

PersonId is an integer type field in the SubscriptionRecipient table that represents a unique identification number for each person who is subscribed to a service or product.

subscriptionId

int32 | null

SubscriptionId is an int data type field in the SubscriptionRecipient table which stores the unique, auto-generated identifier of each individual subscription assigned to a recipient. This is a required field and it ensures each subscription is identified and tracked appropriately within the system.

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

200

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!