Partners

Get partner by id

get

Gets a partner by id

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

idnumberRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

get

/api/partners/{id}

HTTPcURLJavaScriptPython

GET /api/partners/{id} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 1,
  "organizationId": 1,
  "name": "text",
  "addressGroup": {
    "id": 12,
    "name": "Name",
    "description": "Lab",
    "region": "New York",
    "type": "LAB",
    "organizationId": 1,
    "active": true,
    "addressGroupMapping": [],
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-01T00:00:00.000Z",
    "addressMappingCount": 1
  },
  "addressGroupId": 1,
  "partnerTypeId": 1,
  "attributes": {},
  "partnerType": {
    "name": "Test Partner Type Name",
    "description": "Test Partner Type Description",
    "partnerType": "CUSTOM",
    "organizationId": 1,
    "active": true,
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-01T00:00:00.000Z"
  },
  "active": true,
  "createdAt": "2026-02-07",
  "updatedAt": "2026-02-07"
}

Update partner by id

put

Updates a partner by id

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

idnumberRequiredPattern: [^\/#\?]+?

Body

application/json

namestringRequired

Name of the partner

partnerTypeIdintegerRequired

Partner type ID

attributesobjectOptional

Additional attributes for the partner

addressGroupIdnumberOptional

Address group ID

activebooleanOptional

Whether the partner is active

Responses

200Success

application/json

put

/api/partners/{id}

HTTPcURLJavaScriptPython

PUT /api/partners/{id} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 210

{
  "name": "text",
  "partnerTypeId": 1,
  "attributes": {},
  "addressGroupId": 1,
  "addressGroupInput": {
    "name": "Name",
    "description": "Lab",
    "region": "New York",
    "type": "LAB",
    "active": true,
    "addressGroupMapping": []
  },
  "active": true
}

200Success

{
  "id": 1,
  "organizationId": 1,
  "name": "text",
  "addressGroup": {
    "id": 12,
    "name": "Name",
    "description": "Lab",
    "region": "New York",
    "type": "LAB",
    "organizationId": 1,
    "active": true,
    "addressGroupMapping": [],
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-01T00:00:00.000Z",
    "addressMappingCount": 1
  },
  "addressGroupId": 1,
  "partnerTypeId": 1,
  "attributes": {},
  "partnerType": {
    "name": "Test Partner Type Name",
    "description": "Test Partner Type Description",
    "partnerType": "CUSTOM",
    "organizationId": 1,
    "active": true,
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-01T00:00:00.000Z"
  },
  "active": true,
  "createdAt": "2026-02-07",
  "updatedAt": "2026-02-07"
}

Delete partner by id

delete

Deletes a partner by id

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

idnumberRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

delete

/api/partners/{id}

HTTPcURLJavaScriptPython

DELETE /api/partners/{id} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 1,
  "organizationId": 1,
  "name": "text",
  "addressGroup": {
    "id": 12,
    "name": "Name",
    "description": "Lab",
    "region": "New York",
    "type": "LAB",
    "organizationId": 1,
    "active": true,
    "addressGroupMapping": [],
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-01T00:00:00.000Z",
    "addressMappingCount": 1
  },
  "addressGroupId": 1,
  "partnerTypeId": 1,
  "attributes": {},
  "partnerType": {
    "name": "Test Partner Type Name",
    "description": "Test Partner Type Description",
    "partnerType": "CUSTOM",
    "organizationId": 1,
    "active": true,
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-01T00:00:00.000Z"
  },
  "active": true,
  "createdAt": "2026-02-07",
  "updatedAt": "2026-02-07"
}