> ## Documentation Index > Fetch the complete documentation index at: https://docs.snappy.com/llms.txt > Use this file to discover all available pages before exploring further. # Create recipient > Use this endpoint to add a new Recipient to your Company's contact list. Once created, the Recipient can be associated with multiple Accounts and referenced by ID across multiple gift sends. ###### Required fields: - `firstName` - the Recipient's first name - `country` - ISO 3166-1 alpha-2 country code - `accounts` - array of at least one Account ID to associate this Recipient with ###### Optional fields: - `lastName` - the Recipient's last name - `email` - the Recipient's primary email (used as the primary identifier) - `emailOverride` - alternative email for notifications (e.g. personal email when `email` is work email) - `mobilePhone` - mobile phone number - `birthday` - ISO 8601 date for birthday-trigger flows - `externalId` - your internal ID for this Recipient (HRIS, CRM) - `type` - Recipient type. Currently only `employee` is supported. - `employee` - work-related details: `workingSince` (start date), `department` - `owner` - the person responsible for this Recipient: `firstName`, `lastName`, `email` - `recipientCustomFields` - array of custom field objects (`fieldName`, `displayName`, `fieldValue`) ###### Optional parameters: - `companyId` query parameter - Company ID (when not inferable from the calling key) - `Request-Source` header - source of the request ###### Behavior Notes: - Returns `201` with the created Recipient on success. - Returns `409` if a Recipient with the same identifying data already exists in the Company. - Returns `422` for business-rule violations (e.g. invalid Account IDs). - The `source.type` on the response will be `apiIntegration` for recipients created via this endpoint. #### Permissions - Requires: `recipients:create` ## OpenAPI ````yaml post /v2/recipients openapi: 3.0.0 info: title: Snappy Public API version: 2.0.0 contact: name: Snappy Support email: info@snappy.com description: >- Welcome to the Snappy API reference documentation! You can use this API to integrate with Snappy and spread smiles to your employees/clients/customers and much more. In just 3 simple steps you can start sending gifts today: pull the relevant campaign, send gifts to your recipients and track gift statuses. So let's get started! servers: - url: https://api.snappy.com/public-api description: Base API URL - url: https://mtls-api.snappy.com/public-api description: >- ## mTLS URL You can also use mTLS to enhance your API security. To get your specific certificates please contact our support. Once you configure the certificated correctly, you need to also update endpoints to use the following secure api base URL: security: [] tags: - name: Authentication description: >- API keys authenticate requests to the Snappy API. Use these endpoints to list active keys for your Company, create new keys, or delete keys you no longer need. - name: Accounts description: >- An **Account** is a sub-entity that lives within a **Company**. Accounts are used to separate and organize your company's campaigns and gift sends for different teams, departments or budget owners. - name: Campaigns description: >- A **Campaign** is the primary organizational object used to configure and send a batch of gifts. It acts as a template for all the settings of a single gifting initiative, including the target **Recipient** list, the selected **Collection** or **product**, the budget, branding, and notification messages. - name: Collections description: >- A **Collection** is a curated catalog of gift items tailored to a specific theme, budget range, and audience (e.g., "Birthday Gifts Under $50"). The gift recipient then chooses their preferred item directly from this collection. Use these endpoints to: - Get available collections based on budget and country requirements - Retrieve budget ranges for specific collections - Access collection details and products Please note: Swag collections can only be retrieved by specifying the accountId in the request. - name: Products & Variants description: >- Use these endpoints to search for and retrieve products and variants (including by collection and budget), and to list product tags for building catalog and filtering experiences in your UI. - name: Gifts description: >- A **Gift** is the core transactional object in the Snappy system. It represents the entire gifting experience for a **Recipient** within a **Campaign**, from initial creation to final delivery. The **Gift** object tracks the status and details through each stage of its lifecycle: 1. **Creation:** The gift is initiated and associated with a recipient and campaign. 2. **Notification:** The recipient is notified about their gift via email or other channels. 3. **Selection:** The recipient selects a specific product from the gift collection (if applicable). 4. **Order Generation:** An order is created based on the selected product and the recipient's shipping address. 5. **Delivery:** The physical product is shipped and its delivery status is tracked to completion. - name: Orders description: >- Endpoints for programmatically claiming gifts (ordering on behalf of recipients), cancelling orders before they ship, and validating or autocompleting shipping addresses as part of your checkout or fulfillment flow. - name: Recipients description: A **Recipient** is the end-user who receives a **Gift**. paths: /v2/recipients: post: tags: - Recipients summary: Create recipient description: >- Use this endpoint to add a new Recipient to your Company's contact list. Once created, the Recipient can be associated with multiple Accounts and referenced by ID across multiple gift sends. ###### Required fields: - `firstName` - the Recipient's first name - `country` - ISO 3166-1 alpha-2 country code - `accounts` - array of at least one Account ID to associate this Recipient with ###### Optional fields: - `lastName` - the Recipient's last name - `email` - the Recipient's primary email (used as the primary identifier) - `emailOverride` - alternative email for notifications (e.g. personal email when `email` is work email) - `mobilePhone` - mobile phone number - `birthday` - ISO 8601 date for birthday-trigger flows - `externalId` - your internal ID for this Recipient (HRIS, CRM) - `type` - Recipient type. Currently only `employee` is supported. - `employee` - work-related details: `workingSince` (start date), `department` - `owner` - the person responsible for this Recipient: `firstName`, `lastName`, `email` - `recipientCustomFields` - array of custom field objects (`fieldName`, `displayName`, `fieldValue`) ###### Optional parameters: - `companyId` query parameter - Company ID (when not inferable from the calling key) - `Request-Source` header - source of the request ###### Behavior Notes: - Returns `201` with the created Recipient on success. - Returns `409` if a Recipient with the same identifying data already exists in the Company. - Returns `422` for business-rule violations (e.g. invalid Account IDs). - The `source.type` on the response will be `apiIntegration` for recipients created via this endpoint. #### Permissions - Requires: `recipients:create` operationId: createRecipient parameters: - schema: type: string pattern: ^[A-Za-z0-9]{8,}$ description: Company ID example: '12345678' required: false description: Company ID name: companyId in: query - schema: $ref: '#/components/schemas/RequestSourceHeader' required: false description: Source of the request name: Request-Source in: header requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateRecipientBody' responses: '201': description: Recipient created successfully content: application/json: schema: $ref: '#/components/schemas/CreateRecipientResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ApiStringError' '401': description: Unauthorized content: application/json: schema: allOf: - $ref: '#/components/schemas/ApiStringError' - example: status: 401 errorCode: 401_PBLC_001 message: Unauthorized '409': description: Conflict content: application/json: schema: allOf: - $ref: '#/components/schemas/ApiStringError' - example: status: 409 errorCode: 409_PBLC_001 message: Conflict '422': description: Unprocessable Entity content: application/json: schema: allOf: - $ref: '#/components/schemas/ApiStringError' - example: status: 422 errorCode: 422_PBLC_001 message: Unprocessable Entity security: - CompanyLevelAuthentication: [] - BearerAuthentication: [] components: schemas: RequestSourceHeader: type: string enum: - api_native - api_zapier - api_salesforce - api_ftp - api_make description: Source of the request example: api_native CreateRecipientBody: type: object properties: birthday: $ref: '#/components/schemas/DateString' firstName: type: string description: the first name of the recipient example: John lastName: type: string description: the last name of the recipient example: Doe email: type: string description: the email of the recipient, should be a valid email example: john.doe@example.com emailOverride: type: string description: >- The sendingEmail of the recipient in the db, used to override the existing email. example: john.doe.override@example.com mobilePhone: $ref: '#/components/schemas/MobilePhone' country: $ref: '#/components/schemas/Country' accounts: type: array items: type: string minItems: 1 description: >- The accounts ids that the recipient is associated with. Can be copied from Snappy's [dashboard](https://login.snappy.com/workspace/settings/general) or queried in upcoming Accounts API example: - a12bcd34 - a56bcd78 recipientCustomFields: type: array items: type: object properties: fieldName: type: string description: The key name of the custom field. example: petName displayName: type: string description: The display name of the custom field. example: petName fieldValue: type: string description: The value of the custom field. example: Wesley required: - fieldName - fieldValue description: Custom field for recipient. description: The custom fields of the recipient. type: $ref: '#/components/schemas/EmployeeType' employee: $ref: '#/components/schemas/Employee' externalId: type: string description: An external id used by the customer to track their recipients example: '1234567890' owner: type: object properties: firstName: type: string description: >- the first name of the person in charge of the recipient's gifting example: Jane lastName: type: string description: the last name of the person in charge of the recipient's gifting example: Doe email: type: string description: the email of the person in charge of the recipient's gifting example: jane.doe@example.com description: The person in charge of the recipient's gifting. example: firstName: Jane lastName: Doe email: jane.doe@example.com required: - firstName - country - accounts additionalProperties: false description: Create recipient request body. example: birthday: '2022-12-06T00:00:00.000Z' firstName: John lastName: Doe email: john.doe@example.com emailOverride: john.doe.override@example.com mobilePhone: '+1234567890' country: US accounts: - a12bcd34 - a56bcd78 recipientCustomFields: - fieldName: petName displayName: petName fieldValue: Wesley type: employee employee: workingSince: '2022-12-06T00:00:00.000Z' department: R&D CreateRecipientResponse: type: object properties: id: type: string description: The id of the recipient. example: xyz12345 createdAt: type: string format: date-time description: 'Date Format: YYYY-MM-DDThh:mm:ss.sZ.' example: '2022-12-06T09:50:38.536Z' updatedAt: type: string format: date-time description: 'Date Format: YYYY-MM-DDThh:mm:ss.sZ.' example: '2022-12-06T09:50:38.536Z' birthday: $ref: '#/components/schemas/DateString' firstName: type: string description: the first name of the recipient example: John lastName: type: string description: the last name of the recipient example: Doe email: type: string description: the email of the recipient, should be a valid email example: john.doe@example.com emailOverride: type: string description: >- The sendingEmail of the recipient in the db, used to override the existing email. example: john.doe.override@example.com mobilePhone: $ref: '#/components/schemas/MobilePhone' country: $ref: '#/components/schemas/Country' externalId: type: string description: An external id used by the customer to track their recipients example: '1234567890' accounts: type: array items: type: string minItems: 1 description: The accounts ids that the recipient is associated with example: - a12bcd34 - a56bcd78 type: $ref: '#/components/schemas/EmployeeType' recipientCustomFields: type: array items: type: object properties: fieldName: type: string description: The key name of the custom field. example: petName displayName: type: string description: The display name of the custom field. example: petName fieldValue: type: string description: The value of the custom field. example: Wesley required: - fieldName - fieldValue description: Custom field for recipient. description: The custom fields of the recipient. employee: $ref: '#/components/schemas/Employee' updatedBy: type: string nullable: true description: The id of the user who last updated the recipient. example: abc12345 source: type: object properties: type: $ref: '#/components/schemas/RecipientSource' description: The data source of the recipient. example: type: apiIntegration owner: type: object properties: firstName: type: string description: >- the first name of the person in charge of the recipient's gifting example: Jane lastName: type: string description: the last name of the person in charge of the recipient's gifting example: Doe email: type: string description: the email of the person in charge of the recipient's gifting example: jane.doe@example.com description: The person in charge of the recipient's gifting. example: firstName: Jane lastName: Doe email: jane.doe@example.com required: - id - createdAt - updatedAt - firstName - country - accounts - type - updatedBy - source description: Created recipient. example: id: xyz12345 createdAt: '2022-12-06T09:50:38.536Z' updatedAt: '2022-12-06T09:50:38.536Z' firstName: John lastName: Doe email: john.doe@example.com country: US accounts: - a12bcd34 - a56bcd78 type: employee updatedBy: abc12345 source: type: apiIntegration ApiStringError: type: object properties: status: type: integer description: The HTTP status code. example: 400 errorCode: type: string description: >- Internal error code, helps Snappy's technical team to troubleshoot if needed. example: 400_PBLC_001 message: type: string description: The error message. example: Unauthorized errors: type: array items: type: object properties: path: type: string description: The path of the field that caused the error. example: body.recipients.0.email message: type: string description: The error message. example: Invalid email. errorCode: type: string description: >- Internal error code, helps Snappy's technical team to troubleshoot if needed. example: 400_PBLC_002 required: - path - message - errorCode description: >- An array of client errors. This field is being returned only for errors the client should fix, usually with status code 400. required: - status - errorCode - message description: >- API error response with string error codes and optional client error details example: status: 400 errorCode: 400_PBLC_001 message: Bad Request DateString: type: string description: 'Date Format: YYYY-MM-DD.' example: '2022-12-06T00:00:00.000Z' MobilePhone: type: string pattern: ^$|^[0-9 \-+().]{3,7}[0-9 \-+().]{3,7}[0-9]{3,7}$ description: Mobile phone number example: '+1234567890' Country: type: string pattern: ^[A-Za-z]+$ description: Country code example: US EmployeeType: type: string enum: - employee description: The type of employee. example: employee Employee: type: object properties: workingSince: $ref: '#/components/schemas/DateString' department: type: string description: The department of the employee. example: Engineering description: The employee info object. example: workingSince: '2022-01-15T00:00:00.000Z' department: Engineering RecipientSource: type: string enum: - apiIntegration - hrisIntegration - manual - ftpIntegration - fileSync description: The source of the recipient. example: apiIntegration securitySchemes: CompanyLevelAuthentication: type: apiKey in: header name: X-Api-Key description: > ## Company Level Authentication Company level authentication provides access to all resources under your company, including accounts, campaigns, gifts, and recipients. ### Getting Your API Key 1. **Create an API Key**: Use the `POST /v2/authentication/apiKeys` endpoint to generate a new API key 2. **Set Expiration**: Choose from 30, 60, 90, or 180 days (default: 90 days) 3. **Optional mTLS**: Enable mutual TLS for enhanced security 4. **Name Your Key**: Provide a descriptive name for easy identification ### Using Your API Key Include your API key in the `X-Api-Key` header for every request: ``` X-Api-Key: YOUR_24_CHARACTER_API_KEY ``` ### API Key Management - **Maximum Keys**: Up to 3 active API keys per company - **Rotation**: Delete old keys before creating new ones when at the limit - **Security**: Keys are hashed and cannot be retrieved after creation ### Enhanced Security (mTLS) For production environments, enable mutual TLS authentication: 1. Set `enforceMtls: true` when creating the API key 2. Contact support to obtain your client certificates 3. Use the mTLS endpoint: `https://mtls-api.snappy.com/public-api` BearerAuthentication: type: http scheme: bearer bearerFormat: JWT description: >- Bearer authentication provides access to all resources under your company, including accounts, campaigns, gifts, and recipients. ````