RecoupGet a free auditFree audit

API REFERENCE

Add Artist to Organization

On this page
POST/api/organizations/artists

Add an artist to an organization. This allows organization members to access and manage the artist. This endpoint is idempotent - calling it multiple times with the same artistId and organizationId will not create duplicate records.

Authentication

x-api-key in header

bearerAuth bearer

Request

cURL
curl --request POST \
  --url 'https://api.recoupable.dev/api/organizations/artists' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "artistId": "artist-account-uuid",
  "organizationId": "org-account-uuid"
}'

Try it

Fill in the fields, send the request from your browser, and read the live response. The curl below updates as you type.

Kept in this browser tab only and cleared when it closes.

cURL for this request
curl --request POST \
  --url 'https://recoup-api.vercel.app/api/organizations/artists' \
  --header 'Content-Type: application/json' \
  --data '{
  "artistId": "artist-account-uuid",
  "organizationId": "org-account-uuid"
}'

Request body required

Artist-organization association parameters

application/json

artistIdstringrequired

The account ID of the artist to add

format: uuid

organizationIdstringrequired

The account ID of the organization

format: uuid

Responses

200Artist added to organization successfully

application/json

statusstring · enumrequired

Status of the request

Values: "success"

idstringrequired

UUID of the created artist-organization link

format: uuid

400Bad request - missing required parameters

application/json

statusstring · enumrequired

Status of the request

Values: "error"

messagestringrequired

Error message describing what went wrong

401Missing or invalid credentials

application/json

statusstring · enumrequired

Status of the request

Values: "error"

messagestringrequired

Error message describing what went wrong

403Caller is not a member of the organization

application/json

statusstring · enumrequired

Status of the request

Values: "error"

messagestringrequired

Error message describing what went wrong

Full specification

Download the OpenAPI file for complete schemas, constraints, and examples.

Download accounts.json
View operation source
json
{
  "description": "Add an artist to an organization. This allows organization members to access and manage the artist. This endpoint is idempotent - calling it multiple times with the same artistId and organizationId will not create duplicate records.",
  "security": [
    {
      "apiKeyAuth": []
    },
    {
      "bearerAuth": []
    }
  ],
  "requestBody": {
    "description": "Artist-organization association parameters",
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/AddArtistToOrganizationRequest"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Artist added to organization successfully",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/AddArtistToOrganizationResponse"
          }
        }
      }
    },
    "400": {
      "description": "Bad request - missing required parameters",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/OrganizationsErrorResponse"
          }
        }
      }
    },
    "401": {
      "description": "Missing or invalid credentials",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/OrganizationsErrorResponse"
          }
        }
      }
    },
    "403": {
      "description": "Caller is not a member of the organization",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/OrganizationsErrorResponse"
          }
        }
      }
    }
  }
}