NAnayax
Actors

Create a New Actor

Creates a new actor under the specified parent actor. The parent actor is identified by the ParentActorID provided in the path. The request body must contain the details of the new actor.

post/v2/actors/{ParentActorID}

Request

Path parameters

ParentActorIDinteger required

The unique identifier of the parent actor under which the new actor will be created.

Request body

ActorBillingPlanIDinteger

The identifier for the billing plan assigned to the actor.

Response

Actor created successfully.

ParentActorIDinteger nullable

The unique identifier of the parent actor, if applicable.

ActorIDinteger

The unique identifier of the newly created actor.

ActorDescriptionstring nullable

A brief description of the actor.

ActorCodeinteger nullable

A code assigned to the actor, often used for identification or categorization.

ActorContactstring nullable

Contact information for the actor, such as a phone number or email.

ActorTypeIDinteger

The identifier representing the type of actor, defining their role or category.

ActorStatusinteger

The status identifier of the actor, indicating their current status.

ActorHierarchyLevelinteger

The level of hierarchy where the actor is positioned within the organizational structure.

CurrencyIDinteger

The identifier for the currency used by the actor.

LastUpdatedstring date-time

The date and time when the actor's information was last updated.

TimeZoneKeyinteger nullable

The key representing the time zone in which the actor operates.

CountryIDinteger nullable

The identifier for the country in which the actor is located.

OperatorActorIDinteger nullable

The identifier for the operator managing this actor, if applicable.

DistributorActorIDinteger

The identifier for the distributor associated with the actor.

ActorHierarchystring nullable

The hierarchical structure to which the actor belongs.

ActorCreatedByinteger

The identifier of the user who created this actor's record.

ActorCreationDatestring date-time

The date and time when this actor was created.

UpdateByinteger

The identifier of the user who last updated this actor's record.

CultureIDinteger nullable

The identifier for the culture or locale associated with the actor.

GeoCountryIDinteger nullable

The identifier for the country based on the actor's geographic information.

GeoStatestring nullable

The state or region based on the actor's geographic information.

GeoCitystring nullable

The city based on the actor's geographic information.

GeoAddressstring nullable

The address based on the actor's geographic information.

GeoStreetNumberstring nullable

The street number based on the actor's geographic information.

GeoLongitudenumber double nullable

The geographic longitude of the actor's location.

GeoLatitudenumber double nullable

The geographic latitude of the actor's location.

GeoZipCodestring nullable

The zip code based on the actor's geographic information.

GeoZoominteger nullable

The zoom level for map-based services relevant to the actor's geographic location.

ActorLanguageIDunknown
OverrideGeoInherritcanceBitboolean

Indicates whether the actor overrides inherited geographic settings.

Changes

No recorded changes to this operation across all 1 revision of this API.