Send A Physical Gift With Address Confirmation with Sendoso API

Pipedream makes it easy to connect APIs for Sendoso and 1000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Send A Physical Gift With Address Confirmation with the Sendoso API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

Trusted by 500,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Send A Physical Gift With Address Confirmation with the Sendoso API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Send A Physical Gift With Address Confirmation action
1. Connect your Sendoso account
2. Configure Via
3. Select a Group
4. Select a Touch ID
5. Configure Name
6. Configure Address
7. Optional- Configure Address 1
8. Configure City
9. Configure State
10. Configure Country
11. Configure ZIP
12. Optional- Configure Via From
13. Configure Custom Message
14. Optional- Select a Address Confirmation Via
15. Optional- Configure Resume With Unconfirmed Address
16. Optional- Configure No Address
17. Optional- Configure Expire After Days
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Send A Physical Gift With Address Confirmation with Sendoso API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Sendoso

Try it

Send A Physical Gift With Address Confirmation with Sendoso API on New Submission from Typeform API

Typeform + Sendoso

Try it

Send A Physical Gift With Address Confirmation with Sendoso API on Custom Events from Zoom API

Zoom + Sendoso

Try it

Send A Physical Gift With Address Confirmation with Sendoso API on New Submission (Instant) from Jotform API

Jotform + Sendoso

Try it

Send A Physical Gift With Address Confirmation with Sendoso API on New Custom Webhook Events from Stripe API

Stripe + Sendoso

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Send A Physical Gift With Address Confirmation on Sendoso

Description:Send a physical gift. [See the docs here](https://sendoso.docs.apiary.io/#reference/send-management/send-a-gift/sending-a-gift)

Version:0.0.1

Key:sendoso-send-physical-gift-with-address-confirmation

View on GitHub

Code#

import sendoso from "../../sendoso.app.mjs";

export default {
  key: "sendoso-send-physical-gift-with-address-confirmation",
  name: "Send A Physical Gift With Address Confirmation",
  version: "0.0.1",
  description: "Send a physical gift. [See the docs here](https://sendoso.docs.apiary.io/#reference/send-management/send-a-gift/sending-a-gift)",
  type: "action",
  props: {
    sendoso,
    via: {
      propDefinition: [
        sendoso,
        "via",
      ],
    },
    groupId: {
      propDefinition: [
        sendoso,
        "groupId",
      ],
    },
    touchId: {
      propDefinition: [
        sendoso,
        "touchId",
        (c) => ({
          groupId: c.groupId,
        }),
      ],
      description: "The ID of the touch to be sent on this gift",
    },
    name: {
      type: "string",
      label: "Name",
      description: "The name of the person receiving the gift.",
    },
    address: {
      type: "string",
      label: "Address",
      description: "The first line of the street address.",
    },
    address1: {
      type: "string",
      label: "Address 1",
      description: "The second line of the street address if applicable.",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "City of recipients address.",
    },
    state: {
      type: "string",
      label: "State",
      description: "US state of the address (International sending is not available via API at this time).",
    },
    country: {
      type: "string",
      label: "Country",
      description: "E.g. USA",
    },
    zip: {
      type: "string",
      label: "ZIP",
      description: "Zip code of recipients shipping address.",
    },
    viaFrom: {
      propDefinition: [
        sendoso,
        "viaFrom",
      ],
      optional: true,
    },
    customMessage: {
      type: "string",
      label: "Custom Message",
      description: "A freeform text message to be sent along with the gift.",
    },
    addressConfirmationVia: {
      type: "string",
      label: "Address Confirmation Via",
      description: "How the recipient will be asked to confirm their address. Options are `email`, which sends recipient an email, or `link` which provides a link in the response and sends a link to the sender's email address.",
      optional: true,
      options: [
        "email",
        "link",
      ],
    },
    resumeWithUnconfirmedAddress: {
      type: "boolean",
      label: "Resume With Unconfirmed Address",
      description: "Whether or not the gift should be sent if the user does NOT confirm their address.",
      optional: true,
    },
    noAddress: {
      type: "boolean",
      label: "No Address",
      description: "Indicates whether the recipients address is provided or not. When true, will request an address from the recipient either via link or email. Note, if selected email is a required field.",
      optional: true,
    },
    expireAfterDays: {
      type: "integer",
      label: "Expire After Days",
      description: "Sets the number of days the AC form will be valid. Valid values are 2 - 7 inclusive.",
      min: 2,
      max: 7,
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      via,
      touchId,
      name,
      address,
      address1,
      city,
      state,
      country,
      zip,
      viaFrom,
      customMessage,
      addressConfirmationVia,
      resumeWithUnconfirmedAddress,
      noAddress,
      expireAfterDays,
    } = this;

    const response = await this.sendoso.sendGift({
      $,
      via,
      touch_id: touchId,
      name,
      address,
      address1,
      city,
      state,
      country,
      zip,
      via_from: viaFrom,
      custom_message: customMessage,
      confirm_address: "TRUE",
      address_confirmation_via: addressConfirmationVia,
      resume_with_unconfirmed_address: resumeWithUnconfirmedAddress,
      no_address: noAddress,
      expire_after_days: expireAfterDays,
    });

    $.export("$summary", `Gift sent successfully with Tracking Code: ${response.tracking_code}!`);
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Sendoso	`sendoso`	`app`	This component uses the Sendoso app.
Via	`via`	`string`	Specify you want to generate gift links.
Group	`groupId`	`integer`	Select a value from the drop down menu.
Touch ID	`touchId`	`integer`	Select a value from the drop down menu.
Name	`name`	`string`	The name of the person receiving the gift.
Address	`address`	`string`	The first line of the street address.
Address 1	`address1`	`string`	The second line of the street address if applicable.
City	`city`	`string`	City of recipients address.
State	`state`	`string`	US state of the address (International sending is not available via API at this time).
Country	`country`	`string`	E.g. USA
ZIP	`zip`	`string`	Zip code of recipients shipping address.
Via From	`viaFrom`	`string`	Specify the name of your Company or Application.
Custom Message	`customMessage`	`string`	A freeform text message to be sent along with the gift.
Address Confirmation Via	`addressConfirmationVia`	`string`	Select a value from the drop down menu:`emaillink`
Resume With Unconfirmed Address	`resumeWithUnconfirmedAddress`	`boolean`	Whether or not the gift should be sent if the user does NOT confirm their address.
No Address	`noAddress`	`boolean`	Indicates whether the recipients address is provided or not. When true, will request an address from the recipient either via link or email. Note, if selected email is a required field.
Expire After Days	`expireAfterDays`	`integer`	Sets the number of days the AC form will be valid. Valid values are 2 - 7 inclusive.

Authentication#

Sendoso uses OAuth authentication. When you connect your Sendoso account, Pipedream will open a popup window where you can sign into Sendoso and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Sendoso API.

Pipedream requests the following authorization scopes when you connect your account:

publicwriteupdate