Skip to main content
POST
Add an agreement to a publisher
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

id
string<uuid>
required

Body

application/json
agreementType
enum<string>
required
Available options:
original,
sub-publishing,
administration,
collection
agreementNumber
string
required
startDate
string<date-time>
endDate
string<date-time> | null
terms
object

Defaults to { territories: [WW], rightTypes: [PR,MR,SR], shares: { pr: 50, mr: 50, sr: 50 } } when omitted on create.

Response

Agreement created.

id
string<uuid>
TenantId
integer
publisherId
string<uuid>
agreementType
enum<string>
Available options:
original,
sub-publishing,
administration,
collection
agreementNumber
string

Unique per tenant.

startDate
string<date-time>
endDate
string<date-time> | null
terms
object
createdAt
string<date-time>
updatedAt
string<date-time>