Partner API ExplorerAccess
Set a user’s reach
Required scope
partner:access:writePUT
Full replacement. Send disposition: "org" for organization-wide reach, or disposition: "scoped" with a level of brand or venue plus the external ids to allow. Reach can only narrow what the caller themselves can reach, and nobody may widen their own.
header
AuthorizationBearer <token>WorkOS access token (JWT) for a user who is a member of the partner organization. The organization the request is scoped to is taken from the token, not from a header or query parameter.
Only a JWT is accepted in this header. A Journey jny_ API key sent as a bearer token is rejected
with 401 Invalid or expired token; send it in X-API-Key instead.
WorkOS organization API keys are not accepted yet.
workosUserId*stringWorkOS user id of the member of your organization.
organizationId*stringapplication/json- body
disposition*stringValue in
"org""scoped"externalIds?array<>Items
1 <= itemslevel?stringValue in
"brand""venue"The user’s reach after the change.
curl -X PUT 'https://api-prd.cf.journey.com/v1/partner/users/string/scope?organizationId=string' \ -H 'Content-Type: application/json' \ -d '{ "disposition": "org"}'Empty