Skip to main content
POST
/
partners
Error
A valid request URL is required to generate request examples
{
  "company_name": "<string>",
  "sales_amount": 1073741823,
  "partner_type": "customer",
  "email": "jsmith@example.com",
  "frequency": "<string>",
  "payment_terms": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "invitation_status": "invited",
  "guest_organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Requester-Organization-ID
string<uuid>
required

The unique identifier of the organization making the request. This ID is used to authorize the requester within the system.

​
Target-Organization-ID
string<uuid>
required

The unique identifier of the organization that is the target of the request. The Target-Organization-ID may match the Requester-Organization-ID if the requester accesses their own resources. If the Target-Organization-ID differs from the Requester-Organization-ID, the requester can access third-party resources if the requester has a connection with the target organization and is authorized to perform such actions.

Body

application/json
​
company_name
string
required
Required string length: 1 - 100
​
sales_amount
integer
required
Required range: 0 <= x <= 2147483647
​
partner_type
enum<string>
required
Available options:
customer,
supplier
​
email
string<email>
required
Required string length: 1 - 100
​
frequency
string
required
Required string length: 1 - 30
​
payment_terms
string
required
Required string length: 1 - 50

Response

Successful Response

​
company_name
string
required
Required string length: 1 - 100
​
sales_amount
integer
required
Required range: 0 <= x <= 2147483647
​
partner_type
enum<string>
required
Available options:
customer,
supplier
​
email
string<email>
required
Required string length: 1 - 100
​
frequency
string
required
Required string length: 1 - 30
​
payment_terms
string
required
Required string length: 1 - 50
​
id
string<uuid>
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
invitation_status
enum<string> | null
Available options:
invited,
accepted
​
guest_organization_id
string<uuid> | null