Skip to main content
POST
/
partners
Create a partner
curl --request POST \
  --url https://api.example.com/partners \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "partnerTag": "<string>",
  "email": "<string>",
  "firstName": "<string>",
  "middleName": "<string>",
  "lastName": "<string>",
  "contactNumber": "<string>",
  "streetAddressOne": "<string>",
  "city": "<string>",
  "stateOrRegion": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "partnerTag": {
    "id": "<string>",
    "code": "<string>",
    "name": "<string>",
    "description": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deleted": true,
    "deletedAt": "2023-11-07T05:31:56Z"
  },
  "email": "<string>",
  "firstName": "<string>",
  "middleName": "<string>",
  "lastName": "<string>",
  "contactNumber": "<string>",
  "streetAddressOne": "<string>",
  "city": "<string>",
  "stateOrRegion": "<string>"
}

Body

application/json
name
string
required

The name of the partner

partnerTag
string

The tag associated with the partner

email
string

The email of the partner

firstName
string

The first name of the partner

middleName
string

The middle name of the partner

lastName
string

The last name of the partner

contactNumber
string

The contact number of the partner

streetAddressOne
string

The address of the partner

city
string

The city of the partner

stateOrRegion
string

The state of the partner

Response

The partner has been successfully created.

id
string
required

The id of the partner

name
string
required

The name of the partner

partnerTag
object

The tag associated with the partner

email
string

The email of the partner

firstName
string

The first name of the partner

middleName
string

The middle name of the partner

lastName
string

The last name of the partner

contactNumber
string

The contact number of the partner

streetAddressOne
string

The address of the partner

city
string

The city of the partner

stateOrRegion
string

The state of the partner