Skip to content
emely. docs

/v1/societies/{code} (PUT)

PUT
/v1/societies/{code}
curl --request PUT \
  --url https://api.emely.io/v1/societies/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "kind": "example", "homeCountryCode": "example", "cisacCode": "example", "comment": "example", "active": true, "roles": [ { "role": "songwriter", "societyType": "example" } ], "rights": [ "pr" ], "detailRights": [ { "role": "songwriter", "rightType": "pr", "countryCode": "example", "subRights": [ "example" ] } ], "links": [ { "linkedAgencyCode": "example", "rightType": "pr" } ] }'

Create or update one society via the adminUpsertSociety Action. Absence rule: an omitted field or section is untouched upstream; an explicit [] clears that section; explicit null clears homeCountryCode, cisacCode and comment. There is no DELETE: deactivate with active=false.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
code
required
string
>= 1 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
string
>= 1 characters
kind
string
>= 1 characters
homeCountryCode
string | null
>= 1 characters
cisacCode
string | null
>= 1 characters
comment
string | null
active
boolean
roles
Array<object>
object
role
required
string
Allowed values: songwriter publisher performer label
societyType
required
string
>= 1 characters
rights
Array<string>
Allowed values: pr mr nr sr
detailRights
Array<object>
object
role
required
string
Allowed values: songwriter publisher performer label
rightType
required
string
Allowed values: pr mr nr sr
countryCode
required
string
>= 1 characters
subRights
required
Array<string>
links
Array<object>
object
linkedAgencyCode
required
string
>= 1 characters
rightType
required
string
Allowed values: pr mr nr sr

Responses

Section titled “ Responses ”

200

Section titled “200”

The upserted society id and code

Media typeapplication/json
object
id
required
string
code
required
string
Examplegenerated
{
  "id": "example",
  "code": "example"
}

400

Section titled “400”

Validation refused by the Action

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

401

Section titled “401”

Missing or invalid bearer token

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

403

Section titled “403”

Token role refused upstream

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

502

Section titled “502”

Upstream error

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}