Sign in

v1

latestOpenAPI 3.0.42026-07-14475158859.0 KB
Recitation

Update a narration profile (Auth)

put/api/audio/profile

Request body

idstring uuid

Id

userIdstring uuid

UserId

namestring nullable

Profile Name

fileSuffixWithoutDashstring nullable

this would be appended to audio files names prefixed by a dash to make them unique and specfic to user filenames usually would look like {GanjoorPostId}-{FileSuffixWithoutDash}.{ext} for example 2200-hrm.xml

update [4/10/2021]: you can send this one empty

artistNamestring nullable

artist name

artistUrlstring nullable

artist url

audioSrcstring nullable

audio src

audioSrcUrlstring nullable

audio src url

isDefaultboolean

is default

Example request

{
  "user": {
    "username": "test",
    "email": "email@domain.com",
    "phoneNumber": "+989121234567",
    "firstName": "Hamid Reza",
    "surName": "Mohammadi"
  }
}

Response

OK

idstring uuid

Id

userIdstring uuid

UserId

namestring nullable

Profile Name

fileSuffixWithoutDashstring nullable

this would be appended to audio files names prefixed by a dash to make them unique and specfic to user filenames usually would look like {GanjoorPostId}-{FileSuffixWithoutDash}.{ext} for example 2200-hrm.xml

update [4/10/2021]: you can send this one empty

artistNamestring nullable

artist name

artistUrlstring nullable

artist url

audioSrcstring nullable

audio src

audioSrcUrlstring nullable

audio src url

isDefaultboolean

is default

Example response

{
  "user": {
    "username": "test",
    "email": "email@domain.com",
    "phoneNumber": "+989121234567",
    "firstName": "Hamid Reza",
    "surName": "Mohammadi"
  }
}