Conversions API Gateway for Multiple Accounts Control Plane API: Reference

Account Data Routing Configuration

Update Data Routing

Allows defining a first-party domain for the Pixel to communicate with Gateway. More details here.

Schema

POST https://{capig_domain}/capig/graphql/ 
_________________________________________________________________________________________________________________
      
mutation IngressEditingModalMutation(
 $tenantId: ID!
 $input: IngressDomainInput
) {
 tenantMutations(tenantId: $tenantId) {
   upsertIngressDomain(input: $input) {
     id
     ingress
     cnameResolveSuccess
     tenantName
     enhancementTenantIngressVerifiedResult {
       id
       tenantIngressVerified
     }
   }
 }
}
_________________________________________________________________________________________________________
tenantId: ID!
_______________________________________________________________________________________________________
input IngressDomainInput {
  ingress: String!
  targetDomain: String!
}
     

Fields

FieldDescription

tenantId
String

Required

Unique identifier of the account


IngressDomainInput

FieldDescription

ingress
String

Required

New subdomain that needs be updated

targetDomain
String

Required

Partner Gateway Domain


Returns

FieldDescription

IngressDomain
IngressDomain

Ingress domain object


Error Codes

CodeDescription

401

Not authorized to upgrade ingress domain

500

Internal server error


Sample Request

Mutation

 mutation IngressEditingModalMutation(
$tenantId: ID!
$input: IngressDomainInput
) {
tenantMutations(tenantId: $tenantId) {
  upsertIngressDomain(input: $input) {
    id
    ingress
    cnameResolveSuccess
    enhancementTenantIngressVerifiedResult {
      id
      tenantIngressVerified
    }
  }
}
}
     

Variables

{
  "tenantId": "IaoreXfj",
  "input": {
      "ingress": "capig.advertiser.com",
      "targetDomain": "capig.targetDomain.com"
  }
}
     

Sample Response

{
   "data": {
       "tenantMutations": {
           "upsertIngressDomain": {
               "id": "IaoreXfj:ingress",
               "ingress": "capig.advertiser.com",
               "cnameResolveSuccess": true,
               "enhancementTenantIngressVerifiedResult": {
                   "id": "IaoreXfj:tenantIngressVerified",
                   "tenantIngressVerified": true
               }
           }
       }