Import shotgun persons

POST /import/shotgun/persons
Jwt authorization

Import Shotgun persons (users). Send a list of Shotgun person entries in the JSON body. Returns created or updated persons with department associations.

application/json

Body Required

  • id integer

    Shotgun ID of the person

  • firstname string

    First name

  • lastname string

    Last name

  • email string(email)

    Email address

  • login string

    Desktop login

  • sg_status_list string

    Status list

  • permission_rule_set object

    Permission rule set

    Hide permission_rule_set attribute Show permission_rule_set attribute object
    • name string
  • department object

    Department information

    Hide department attribute Show department attribute object
    • name string

Responses

  • 200 application/json

    Persons imported successfully

    Hide response attributes Show response attributes object
    • id string(uuid)

      Person unique identifier

    • first_name string

      First name

    • last_name string

      Last name

    • email string(email)

      Email address

    • role string

      User role

    • created_at string(date-time)

      Creation timestamp

    • updated_at string(date-time)

      Update timestamp
  • 400

    Invalid request body or data format error

POST /import/shotgun/persons 
curl \
 --request POST 'http://api.example.com/import/shotgun/persons' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '[{"id":12345,"email":"john.doe@example.com","login":"jdoe","lastname":"Doe","firstname":"John","department":{"name":"Animation"},"sg_status_list":"act","permission_rule_set":{"name":"Manager"}}]'
Request example 
[
  {
    "id": 12345,
    "email": "john.doe@example.com",
    "login": "jdoe",
    "lastname": "Doe",
    "firstname": "John",
    "department": {
      "name": "Animation"
    },
    "sg_status_list": "act",
    "permission_rule_set": {
      "name": "Manager"
    }
  }
]
Response examples (200) 
[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "role": "manager",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T11:00:00Z"
  }
]