Attaches a campaign to the entitlement as a manual touch.

POST

/api/v1/provision/admin/entitlements/{entitlementId}/campaign-attributions

curl --request POST \
  --url https://example.com/api/v1/provision/admin/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/campaign-attributions \
  --header 'Content-Type: application/json' \
  --data '{ "campaignId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Parameters

Path Parameters

entitlementId

required

string format: uuid

Entitlement id.

Request Body^required

Attribution payload (campaign id).

Admin request to attach a campaign to an entitlement as a manual touch.

object

campaignId

string format: uuid

Example^generated

{
  "campaignId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Admin request to attach a campaign to an entitlement as a manual touch.

object

campaignId

string format: uuid

Example^generated

{
  "campaignId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Admin request to attach a campaign to an entitlement as a manual touch.

object

campaignId

string format: uuid

Example^generated

{
  "campaignId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

OK

One campaign touch on an entitlement, denormalized with the campaign’s display fields. The entitlement’s earliest Issuance or Manual touch claims its revenue (first-touch attribution).

object

id

string format: uuid

campaignId

string format: uuid

campaignName

Campaign display name; kept even when the campaign has since been deleted.

string

campaignCode

string

touchpoint

How a campaign touched an entitlement.

Allowed values: Issuance Manual PlanOverride AddOnGrant

creationTimeStamp

When the touch was recorded.

string format: date-time

One campaign touch on an entitlement, denormalized with the campaign’s display fields. The entitlement’s earliest Issuance or Manual touch claims its revenue (first-touch attribution).

object

id

string format: uuid

campaignId

string format: uuid

campaignName

Campaign display name; kept even when the campaign has since been deleted.

string

campaignCode

string

touchpoint

How a campaign touched an entitlement.

Allowed values: Issuance Manual PlanOverride AddOnGrant

creationTimeStamp

When the touch was recorded.

string format: date-time

Example

{
  "touchpoint": "Issuance"
}

One campaign touch on an entitlement, denormalized with the campaign’s display fields. The entitlement’s earliest Issuance or Manual touch claims its revenue (first-touch attribution).

object

id

string format: uuid

campaignId

string format: uuid

campaignName

Campaign display name; kept even when the campaign has since been deleted.

string

campaignCode

string

touchpoint

How a campaign touched an entitlement.

Allowed values: Issuance Manual PlanOverride AddOnGrant

creationTimeStamp

When the touch was recorded.

string format: date-time

Example

{
  "touchpoint": "Issuance"
}

400

Bad Request

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}