Edit an Eligibility Subscription

PATCH 
/v1/eligibility-subscriptions/:id

Update an Eligibility Subscription's metadata.

Request

Path Parameters

id stringrequired

Id of the Eligibility Subscription.

application/json

Body

required

metadata object

Metadata object that will be merged with current metadata object.

property name* string

Max key size is 40 characters. If key matches already existing key, it will override old value

Responses

200

Successfully updates Eligibility Subscription's metadata

application/json

Schema

Schema

data object
id string
organisationId stringnullable
organisationName stringnullable
partnerId string
configurationId string
validationRequestId stringnullable
suggestedActivitySubTags object[]nullable
Array [
id string
name string
SubTag name
tag object
id string
name string
Tag name
description stringnullable
Tag description
createdAt date-time
updatedAt date-timenullable
description stringnullable
SubTag description
createdAt date-time
updatedAt date-timenullable
]
status string
Possible values: [live, pending_validation_request, validation_request_failed, pending, cancelled, cannot_define_eligibility]
results object
eligibilityStatus stringnullable
Possible values: [pass, fail]
confirmedActivitySubTags object[]nullable
Array [
id string
name string
SubTag name
tag object
id string
name string
Tag name
description stringnullable
Tag description
createdAt date-time
updatedAt date-timenullable
description stringnullable
SubTag description
createdAt date-time
updatedAt date-timenullable
]
rejectedActivitySubTags object[]nullable
Confirmed organisation's activity subtags that are not allowed in partner's configuration
Array [
id string
name string
SubTag name
tag object
id string
name string
Tag name
description stringnullable
Tag description
createdAt date-time
updatedAt date-timenullable
description stringnullable
SubTag description
createdAt date-time
updatedAt date-timenullable
]
createdAt date-time
updatedAt date-timenullable
object string

Example (from schema)

{
  "data": {
    "id": "eligibilitysubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "organisationId": "organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "organisationName": "string",
    "partnerId": "string",
    "configurationId": "string",
    "validationRequestId": "validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "suggestedActivitySubTags": [
      {
        "id": "activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "name": "Sport school",
        "tag": {
          "id": "activitytag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
          "name": "Education",
          "description": "string",
          "createdAt": "2020-10-13T17:46:54.000Z",
          "updatedAt": "2020-10-13T17:46:54.000Z"
        },
        "description": "string",
        "createdAt": "2020-10-13T17:46:54.000Z",
        "updatedAt": "2020-10-13T17:46:54.000Z"
      }
    ],
    "status": "live",
    "results": {
      "eligibilityStatus": "fail",
      "confirmedActivitySubTags": [
        {
          "id": "activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
          "name": "Sport school",
          "tag": {
            "id": "activitytag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            "name": "Education",
            "description": "string",
            "createdAt": "2020-10-13T17:46:54.000Z",
            "updatedAt": "2020-10-13T17:46:54.000Z"
          },
          "description": "string",
          "createdAt": "2020-10-13T17:46:54.000Z",
          "updatedAt": "2020-10-13T17:46:54.000Z"
        }
      ],
      "rejectedActivitySubTags": [
        {
          "id": "activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
          "name": "Sport school",
          "tag": {
            "id": "activitytag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            "name": "Education",
            "description": "string",
            "createdAt": "2020-10-13T17:46:54.000Z",
            "updatedAt": "2020-10-13T17:46:54.000Z"
          },
          "description": "string",
          "createdAt": "2020-10-13T17:46:54.000Z",
          "updatedAt": "2020-10-13T17:46:54.000Z"
        }
      ]
    },
    "createdAt": "2020-10-13T17:46:54.000Z",
    "updatedAt": "2020-10-13T17:46:54.000Z"
  },
  "object": "eligibility_subscription"
}

400

Bad request

application/json

Schema

Schema

error object
code string
title string
message string
reasons string[]nullable

Example (from schema)

{
  "error": {
    "code": "string",
    "title": "string",
    "message": "string",
    "reasons": [
      "string"
    ]
  }
}

InvalidMetadata

400 Bad request

{
  "error": {
    "title": "Bad request",
    "message": "Metadata can only contain from 1 up to 20 keys, with key names up to 50 characters long and values up to 500 characters long",
    "code": "eligibility_subscription/invalid_metadata"
  }
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error object
code string
title string
message string

Example (from schema)

{
  "error": {
    "code": "forbidden",
    "title": "Forbidden",
    "message": "Access is denied due to missing scope permissions"
  }
}

404

The specified resource was not found

application/json

Schema

Schema

error object
code string
title string
message string

Example (from schema)

{
  "error": {
    "code": "not_found",
    "title": "Resource not found",
    "message": "This endpoint is unavailable or can not be found"
  }
}

Loading...