Agent Email
Show an email placement
GET /v1/agent-email/placements/{placementId} · SDK getAgentEmailPlacement · CLI deployments email-placement show
GET
Requires agent-email:read.
platformBearerheader
AuthorizationBearer <token>Platform bearer credential accepted as an opaque API key or JWT.
placementId*stringMatch
^[0-7][0-9A-HJKMNP-TV-Z]{25}$x-deployments-environment*stringMatch
^[0-7][0-9A-HJKMNP-TV-Z]{25}$AgentEmailPlacementResponse
application/json- response
createdAt*stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timededicatedPool*booleanestimatedMonthlyCostCents?integerRange
0 <= value <= 9007199254740991id*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$isDefault*booleanlastReconciledAt?stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timename*stringorganizationId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$provider*stringproviderMetadata*reconciliationError?stringregion*stringsecondaryRegion?stringstatus*stringValue in
"active""deprovisioning""disabled""failed""provisioning""reconciling"updatedAt*stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timecurl -X GET "https://example.com/v1/agent-email/placements/string" \ -H "x-deployments-environment: string"{ "createdAt": "2019-08-24T14:15:22Z", "dedicatedPool": true, "estimatedMonthlyCostCents": 0, "id": "string", "isDefault": true, "lastReconciledAt": "2019-08-24T14:15:22Z", "name": "string", "organizationId": "string", "provider": "string", "providerMetadata": { "property1": null, "property2": null }, "reconciliationError": "string", "region": "string", "secondaryRegion": "string", "status": "active", "updatedAt": "2019-08-24T14:15:22Z"}