This page was automatically generated from tracezilla’s Swagger API documentation 2026-07-17

POST /partners/{partnerId}/invite

Send new invitation

Description

Send a new invitation

Parameters (path)

Name Required Description Values
partnerId required Id of partner.  

Request body

Description

Target partner.

Required

This parameter is required.

Request body JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

{
  "required": [
    "message"
  ],
  "properties": {
    "id": {
      "description": "Id of the message-record",
      "type": "string",
      "format": "uuid",
      "readOnly": true,
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "message": {
      "description": "The personal message that should be send to the partner",
      "type": "string",
      "format": "string",
      "example": "The message to place on the order"
    },
    "source": {
      "description": "Source of the inviation",
      "type": "string",
      "format": "string",
      "example": "purchase"
    },
    "email": {
      "description": "Email of the recipient",
      "type": "string",
      "format": "string",
      "example": "example@tracezilla.com"
    },
    "partner_id": {
      "description": "Reference to the partner model",
      "type": "string",
      "format": "uuid",
      "readOnly": true,
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "invited_by_id": {
      "description": "Id of the user that created the invitaion. Will default to the signed in user if left empty on creation",
      "type": "integer",
      "format": "int32",
      "example": 22
    },
    "created_at": {
      "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "example": "2019-01-01T13:25:32.312Z"
    },
    "updated_at": {
      "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "example": "2020-01-01T13:25:32.312Z"
    }
  },
  "type": "object"
}

Responses

201

successful operation

403

Unauthorized request

406

not acceptable

422

Has validation errors

500

internal server error