Create new partner

  • 1 minute(s) read
Prev Next
Post
/network/partners

Required permissions: READ_PARTNER, WRITE_PARTNER.

Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired

The name of the target tenant (e.g. acme).

Body parameters

The details of partner being created.

Expand All
object
name
string
code
string

The code identifying the partner.

country
string

The country the organization belongs to.

timezone
string

The timezone used for date/times localization (e.g. Europe/Rome).

customerCount
number

The number of customers associated to the partner.

properties
object (Properties)

The set of properties providing additional details to the parent object.

Example{ "foo": "abc", "bar": "123" }
property*
string additionalProperties
organization
object

The parent organization identifier.

id
string
Example1234abcd
creationTimestamp
integer (int64)

The timestamp at which the object was created.

Responses
201

Successful creation.

Expand All
object
id
string

The partner object identifier.

name
string
code
string

The code identifying the partner.

country
string

The country the organization belongs to.

timezone
string

The timezone used for date/times localization (e.g. Europe/Rome).

customerCount
number

The number of customers associated to the partner.

properties
object (Properties)

The set of properties providing additional details to the parent object.

Example{ "foo": "abc", "bar": "123" }
property*
string additionalProperties
organization
object

The parent organization identifier.

id
string
Example1234abcd
creationTimestamp
integer (int64)

The timestamp at which the object was created.

401

User not authenticated.

object
message
string

The error response.

ExampleUser not authenticated
403

User not authorized.

object
message
string

The error response.

ExampleUser not authorized
404

Resource was not found.

object
message
string

The error response.

ExampleResource not found
429

API call rate limit exeeded.

object
message
string

The error response.

ExampleAPI call rate limit exeeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error