Collecting Business Information

To create partnerships successfully, you will want to create a form similar to the one shown that collects your vendor's legal business name and type.

A simple partnership collection formA simple partnership collection form

A simple partnership collection form

We're assuming you've already collected your vendor's email address and name as part of registering for the platform... but if you haven't now might be a good time to grab those too!

After collecting this information, submit a Create Partnership request to get them into the Routable system.

// POST /partnerships/ HTTP/1.1
// Accept: application/vnd.api+json
// Content-Type: application/vnd.api+json

{
  "data": {
    "attributes": {
      "is_customer": false,
      "is_vendor": true
    },
    "relationships": {
      "partnership_members": {
        "data": [
          {
            "attributes": {
              "default_general": "actionable",
              "default_item": "actionable",
              "email": "[email protected]",
              "first_name": "Zaldy",
              "last_name": "Worker"
            },
            "type": "PartnershipMember"
          }
        ]
      },
      "partner": {
        "data": {
          "attributes": {
            "company_type": "business",
            "name": "InstaWork"
          },
          "type": "Company"
        }
      },
      "requester": {
        "data": {
          "id": "451795f6-f54f-4861-ba55-6c22b097a6e4",
          "type": "Membership"
        }
      }
    },
    "type": "Partnership"
  }
}
{
  "data":{
    "type":"Partnership",
    "id":"a99945e9-815a-4ba7-9e57-cc88972d0222",
    "attributes":{
      "created":"2021-03-19T16:32:05.426946Z",
      "customer_ref":null,
      "external_ref":null,
      "is_customer":false,
      "is_ledger_only":false,
      "is_vendor":true,
      "name":"InstaWork",
      "partner_status":"added",
      "vendor_ref":null
    },
    "relationships":{
      "partner":{
        "data":{
          "type":"Company",
          "id":"5c81ac75-1599-4991-987a-8418d92698f2"
        }
      },
      "partnership_members":{
        "data":[
          {
            "type":"PartnershipMember",
            "id":"49c49dfc-60c0-42cf-8bd4-8ec6e4f4ea04"
          },
          {
            "type":"PartnershipMember",
            "id":"082ddd91-5882-48d5-8253-c3e550ae178f"
          }
        ]
      }
    }
  },
  "included":[
    {
      "type":"Company",
      "id":"5c81ac75-1599-4991-987a-8418d92698f2",
      "attributes":{
        "company_type":"business",
        "name":"InstaWork"
      }
    },
    {
      "type":"PartnershipMember",
      "id":"082ddd91-5882-48d5-8253-c3e550ae178f",
      "attributes":{
        "avatar":null,
        "default_general":"actionable",
        "default_item":"actionable",
        "email":"[email protected]",
        "first_name":"Zaldy",
        "is_archived":false,
        "last_name":"Worker",
        "notification_general":"none",
        "phone_number":null,
        "debug_jwt_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZW1iZXJzaGlwX2lkIjoiNWExYTY4OWYtYzRmNy00Y2JjLWI0ZTQtZmY5NGE4YjhkNjc1IiwiZW1haWwiOiJ6YWxkeUBpbnN0YXdvcmsuY29tIiwiZXhwIjoxNjIxMzU1NTI1fQ.79KSi5TLd_tLtCmR93XN00ZbLfDY4VeCjCI8ksBp52M",
        "debug_partnership_id":"bf179465-3125-4c83-bcd9-7b33ee8a59e3"
      },
      "relationships":{
        "company":{
          "data":{
            "type":"Company",
            "id":"5c81ac75-1599-4991-987a-8418d92698f2"
          }
        },
        "membership":{
          "data":{
            "type":"Membership",
            "id":"5a1a689f-c4f7-4cbc-b4e4-ff94a8b8d675"
          }
        },
        "notification_bounce":{
          "data":null
        }
      }
    },
    {
      "type":"PartnershipMember",
      "id":"49c49dfc-60c0-42cf-8bd4-8ec6e4f4ea04",
      "attributes":{
        "avatar":null,
        "default_general":"self_managed",
        "default_item":"self_managed",
        "email":"[email protected]",
        "first_name":"Kevin",
        "is_archived":false,
        "last_name":"Malone",
        "notification_general":"self_managed",
        "phone_number":{
          "number":"+11917280016",
          "country":"US"
        },
        "debug_jwt_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZW1iZXJzaGlwX2lkIjoiNDUxNzk1ZjYtZjU0Zi00ODYxLWJhNTUtNmMyMmIwOTdhNmU0IiwiZW1haWwiOiJrZXZpbkBkdW5kZXJtaWZmbGluLmNvbSIsImV4cCI6MTYyMTM1NTUyNX0.u8k_Zx9jvsq_T4htN-LVLU-VBtspVTd7f2X-WG6d8Zw",
        "debug_partnership_id":"a99945e9-815a-4ba7-9e57-cc88972d0222"
      },
      "relationships":{
        "company":{
          "data":{
            "type":"Company",
            "id":"e4163ce1-dc78-47a0-ae6c-68aab52411e8"
          }
        },
        "membership":{
          "data":{
            "type":"Membership",
            "id":"451795f6-f54f-4861-ba55-6c22b097a6e4"
          }
        },
        "notification_bounce":{
          "data":null
        }
      }
    }
  ]
}

See the Create a Partnership operation definition for details about the request and response attributes.


Did this page help you?