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

idstring

Example: eligibilitysubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

organisationIdstringnullable

Example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

organisationNamestringnullable

partnerIdstring

configurationIdstring

validationRequestIdstringnullable

Example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

suggestedActivitySubTags

object[]

nullable

Array [

idstring

Example: activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

namestring

SubTag name

Example: Sport school

tag

object

idstring

Example: activitytag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

namestring

Tag name

Example: Education

descriptionstringnullable

Tag description

createdAtdate-time

Example: 2020-10-13T17:46:54.000Z

updatedAtdate-timenullable

Example: 2020-10-13T17:46:54.000Z

descriptionstringnullable

SubTag description

createdAtdate-time

Example: 2020-10-13T17:46:54.000Z

updatedAtdate-timenullable

Example: 2020-10-13T17:46:54.000Z

]

statusstring

Possible values: [live, pending_validation_request, validation_request_failed, pending, cancelled, cannot_define_eligibility]

Example: live

results

object

eligibilityStatusstringnullable

Possible values: [pass, fail]

Example: fail

confirmedActivitySubTags

object[]

nullable

Array [

idstring

Example: activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

namestring

SubTag name

Example: Sport school

tag

object

idstring

Example: activitytag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

namestring

Tag name

Example: Education

descriptionstringnullable

Tag description

createdAtdate-time

Example: 2020-10-13T17:46:54.000Z

updatedAtdate-timenullable

Example: 2020-10-13T17:46:54.000Z

descriptionstringnullable

SubTag description

createdAtdate-time

Example: 2020-10-13T17:46:54.000Z

updatedAtdate-timenullable

Example: 2020-10-13T17:46:54.000Z

]

rejectedActivitySubTags

object[]

nullable

Confirmed organisation's activity subtags that are not allowed in partner's configuration

Array [

idstring

Example: activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

namestring

SubTag name

Example: Sport school

tag

object

idstring

Example: activitytag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

namestring

Tag name

Example: Education

descriptionstringnullable

Tag description

createdAtdate-time

Example: 2020-10-13T17:46:54.000Z

updatedAtdate-timenullable

Example: 2020-10-13T17:46:54.000Z

descriptionstringnullable

SubTag description

createdAtdate-time

Example: 2020-10-13T17:46:54.000Z

updatedAtdate-timenullable

Example: 2020-10-13T17:46:54.000Z

]

createdAtdate-time

Example: 2020-10-13T17:46:54.000Z

updatedAtdate-timenullable

Example: 2020-10-13T17:46:54.000Z
objectstring
Example: eligibility_subscription

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

codestring

titlestring

messagestring

reasonsstring[]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

codestring

Example: forbidden

titlestring

Example: Forbidden

messagestring

Example: Access is denied due to missing scope permissions

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

codestring

Example: not_found

titlestring

Example: Resource not found

messagestring

Example: This endpoint is unavailable or can not be found

Example (from schema)

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