Create Return Portal

Creates a return portal in Webshipper.

POST

Query

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Body

Arguments

stringrequired

Name of the return portal.

stringrequired

The order channel ID to connect to the portal.

string

Optional slip template ID.

string

Optional mail template ID.

string

Optional return address ID.

Try this request

Request

curl --request POST \
  --url "https://connect.mindcloud.co/v1/universal/webshipper/0.0.6/actions/create-return-portal" \
  --header "Authorization: Bearer $MINDCLOUD_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "data.attributes.name": "",
  "data.relationships.orderChannel.data.id": ""
}'

{
  "success": true,
  "data": [
    {
      "allowed_days_since_dispatch": "string",
      "custom_style": "string",
      "email_address_resource_options": [
        "[email protected]"
      ],
      "email_address_source": "[email protected]",
      "finished_stripe_setup": "string",
      "force_single_page": true,
      "id": "string",
      "locale": "string",
      "logo": "string",
      "mail_templateId": "string",
      "name": "Ava Chen",
      "new_confirmation_mail_template": "string",
      "new_mail_template": "string",
      "optional_return_cause": true,
      "order_channel_id": 1,
      "order_channel_logo": "string",
      "send_immediately": true,
      "shipping_methods": [
        "string"
      ],
      "static_notice_email": "[email protected]",
      "translations": [
        "string"
      ],
      "type": "string"
    }
  ],
  "meta": {}
}

Every app you connect,one REST pattern

Call any app with one REST pattern. MindCloud handles each provider's auth, request shape, and responses for you.

Learn what the Universal API is

One REST patternUse the same request structure across apps like Slack, HubSpot, Salesforce, and thousands more.

Managed connectionsSend a MindCloud connection ID instead of handling provider tokens, refresh logic, and credential storage yourself.

Action-level docsEach action page shows the exact endpoint, required arguments, optional controls, and response behavior for that app version.